2009-02-25 Hui Zhu <teawater@gmail.com>
[external/binutils.git] / gdb / solib-irix.c
1 /* Shared library support for IRIX.
2    Copyright (C) 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002, 2004,
3    2007, 2008, 2009 Free Software Foundation, Inc.
4
5    This file was created using portions of irix5-nat.c originally
6    contributed to GDB by Ian Lance Taylor.
7
8    This file is part of GDB.
9
10    This program is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 3 of the License, or
13    (at your option) any later version.
14
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
22
23 #include "defs.h"
24
25 #include "symtab.h"
26 #include "bfd.h"
27 /* FIXME: ezannoni/2004-02-13 Verify that the include below is
28    really needed.  */
29 #include "symfile.h"
30 #include "objfiles.h"
31 #include "gdbcore.h"
32 #include "target.h"
33 #include "inferior.h"
34 #include "gdbthread.h"
35
36 #include "solist.h"
37 #include "solib.h"
38 #include "solib-irix.h"
39
40
41 /* Link map info to include in an allocate so_list entry.  Unlike some
42    of the other solib backends, this (Irix) backend chooses to decode
43    the link map info obtained from the target and store it as (mostly)
44    CORE_ADDRs which need no further decoding.  This is more convenient
45    because there are three different link map formats to worry about.
46    We use a single routine (fetch_lm_info) to read (and decode) the target
47    specific link map data.  */
48
49 struct lm_info
50 {
51   CORE_ADDR addr;               /* address of obj_info or obj_list
52                                    struct on target (from which the
53                                    following information is obtained).  */
54   CORE_ADDR next;               /* address of next item in list.  */
55   CORE_ADDR reloc_offset;       /* amount to relocate by  */
56   CORE_ADDR pathname_addr;      /* address of pathname  */
57   int pathname_len;             /* length of pathname */
58 };
59
60 /* It's not desirable to use the system header files to obtain the
61    structure of the obj_list or obj_info structs.  Therefore, we use a
62    platform neutral representation which has been derived from the IRIX
63    header files.  */
64
65 typedef struct
66 {
67   gdb_byte b[4];
68 }
69 gdb_int32_bytes;
70 typedef struct
71 {
72   gdb_byte b[8];
73 }
74 gdb_int64_bytes;
75
76 /* The "old" obj_list struct.  This is used with old (o32) binaries.
77    The ``data'' member points at a much larger and more complicated
78    struct which we will only refer to by offsets.  See
79    fetch_lm_info().  */
80
81 struct irix_obj_list
82 {
83   gdb_int32_bytes data;
84   gdb_int32_bytes next;
85   gdb_int32_bytes prev;
86 };
87
88 /* The ELF32 and ELF64 versions of the above struct.  The oi_magic value
89    corresponds to the ``data'' value in the "old" struct.  When this value
90    is 0xffffffff, the data will be in one of the following formats.  The
91    ``oi_size'' field is used to decide which one we actually have.  */
92
93 struct irix_elf32_obj_info
94 {
95   gdb_int32_bytes oi_magic;
96   gdb_int32_bytes oi_size;
97   gdb_int32_bytes oi_next;
98   gdb_int32_bytes oi_prev;
99   gdb_int32_bytes oi_ehdr;
100   gdb_int32_bytes oi_orig_ehdr;
101   gdb_int32_bytes oi_pathname;
102   gdb_int32_bytes oi_pathname_len;
103 };
104
105 struct irix_elf64_obj_info
106 {
107   gdb_int32_bytes oi_magic;
108   gdb_int32_bytes oi_size;
109   gdb_int64_bytes oi_next;
110   gdb_int64_bytes oi_prev;
111   gdb_int64_bytes oi_ehdr;
112   gdb_int64_bytes oi_orig_ehdr;
113   gdb_int64_bytes oi_pathname;
114   gdb_int32_bytes oi_pathname_len;
115   gdb_int32_bytes padding;
116 };
117
118 /* Union of all of the above (plus a split out magic field).  */
119
120 union irix_obj_info
121 {
122   gdb_int32_bytes magic;
123   struct irix_obj_list ol32;
124   struct irix_elf32_obj_info oi32;
125   struct irix_elf64_obj_info oi64;
126 };
127
128 /* MIPS sign extends its 32 bit addresses.  We could conceivably use
129    extract_typed_address here, but to do so, we'd have to construct an
130    appropriate type.  Calling extract_signed_integer seems simpler.  */
131
132 static CORE_ADDR
133 extract_mips_address (void *addr, int len)
134 {
135   return extract_signed_integer (addr, len);
136 }
137
138 /* Fetch and return the link map data associated with ADDR.  Note that
139    this routine automatically determines which (of three) link map
140    formats is in use by the target.  */
141
142 static struct lm_info
143 fetch_lm_info (CORE_ADDR addr)
144 {
145   struct lm_info li;
146   union irix_obj_info buf;
147
148   li.addr = addr;
149
150   /* The smallest region that we'll need is for buf.ol32.  We'll read
151      that first.  We'll read more of the buffer later if we have to deal
152      with one of the other cases.  (We don't want to incur a memory error
153      if we were to read a larger region that generates an error due to
154      being at the end of a page or the like.)  */
155   read_memory (addr, (char *) &buf, sizeof (buf.ol32));
156
157   if (extract_unsigned_integer (buf.magic.b, sizeof (buf.magic)) != 0xffffffff)
158     {
159       /* Use buf.ol32... */
160       char obj_buf[432];
161       CORE_ADDR obj_addr = extract_mips_address (&buf.ol32.data,
162                                                  sizeof (buf.ol32.data));
163       li.next = extract_mips_address (&buf.ol32.next, sizeof (buf.ol32.next));
164
165       read_memory (obj_addr, obj_buf, sizeof (obj_buf));
166
167       li.pathname_addr = extract_mips_address (&obj_buf[236], 4);
168       li.pathname_len = 0;      /* unknown */
169       li.reloc_offset = extract_mips_address (&obj_buf[196], 4)
170         - extract_mips_address (&obj_buf[248], 4);
171
172     }
173   else if (extract_unsigned_integer (buf.oi32.oi_size.b,
174                                      sizeof (buf.oi32.oi_size))
175            == sizeof (buf.oi32))
176     {
177       /* Use buf.oi32...  */
178
179       /* Read rest of buffer.  */
180       read_memory (addr + sizeof (buf.ol32),
181                    ((char *) &buf) + sizeof (buf.ol32),
182                    sizeof (buf.oi32) - sizeof (buf.ol32));
183
184       /* Fill in fields using buffer contents.  */
185       li.next = extract_mips_address (&buf.oi32.oi_next,
186                                       sizeof (buf.oi32.oi_next));
187       li.reloc_offset = extract_mips_address (&buf.oi32.oi_ehdr,
188                                               sizeof (buf.oi32.oi_ehdr))
189         - extract_mips_address (&buf.oi32.oi_orig_ehdr,
190                                 sizeof (buf.oi32.oi_orig_ehdr));
191       li.pathname_addr = extract_mips_address (&buf.oi32.oi_pathname,
192                                                sizeof (buf.oi32.oi_pathname));
193       li.pathname_len = extract_unsigned_integer (buf.oi32.oi_pathname_len.b,
194                                                   sizeof (buf.oi32.
195                                                           oi_pathname_len));
196     }
197   else if (extract_unsigned_integer (buf.oi64.oi_size.b,
198                                      sizeof (buf.oi64.oi_size))
199            == sizeof (buf.oi64))
200     {
201       /* Use buf.oi64...  */
202
203       /* Read rest of buffer.  */
204       read_memory (addr + sizeof (buf.ol32),
205                    ((char *) &buf) + sizeof (buf.ol32),
206                    sizeof (buf.oi64) - sizeof (buf.ol32));
207
208       /* Fill in fields using buffer contents.  */
209       li.next = extract_mips_address (&buf.oi64.oi_next,
210                                       sizeof (buf.oi64.oi_next));
211       li.reloc_offset = extract_mips_address (&buf.oi64.oi_ehdr,
212                                               sizeof (buf.oi64.oi_ehdr))
213         - extract_mips_address (&buf.oi64.oi_orig_ehdr,
214                                 sizeof (buf.oi64.oi_orig_ehdr));
215       li.pathname_addr = extract_mips_address (&buf.oi64.oi_pathname,
216                                                sizeof (buf.oi64.oi_pathname));
217       li.pathname_len = extract_unsigned_integer (buf.oi64.oi_pathname_len.b,
218                                                   sizeof (buf.oi64.
219                                                           oi_pathname_len));
220     }
221   else
222     {
223       error (_("Unable to fetch shared library obj_info or obj_list info."));
224     }
225
226   return li;
227 }
228
229 /* The symbol which starts off the list of shared libraries.  */
230 #define DEBUG_BASE "__rld_obj_head"
231
232 static void *base_breakpoint;
233
234 static CORE_ADDR debug_base;    /* Base of dynamic linker structures */
235
236 /*
237
238    LOCAL FUNCTION
239
240    locate_base -- locate the base address of dynamic linker structs
241
242    SYNOPSIS
243
244    CORE_ADDR locate_base (void)
245
246    DESCRIPTION
247
248    For both the SunOS and SVR4 shared library implementations, if the
249    inferior executable has been linked dynamically, there is a single
250    address somewhere in the inferior's data space which is the key to
251    locating all of the dynamic linker's runtime structures.  This
252    address is the value of the symbol defined by the macro DEBUG_BASE.
253    The job of this function is to find and return that address, or to
254    return 0 if there is no such address (the executable is statically
255    linked for example).
256
257    For SunOS, the job is almost trivial, since the dynamic linker and
258    all of it's structures are statically linked to the executable at
259    link time.  Thus the symbol for the address we are looking for has
260    already been added to the minimal symbol table for the executable's
261    objfile at the time the symbol file's symbols were read, and all we
262    have to do is look it up there.  Note that we explicitly do NOT want
263    to find the copies in the shared library.
264
265    The SVR4 version is much more complicated because the dynamic linker
266    and it's structures are located in the shared C library, which gets
267    run as the executable's "interpreter" by the kernel.  We have to go
268    to a lot more work to discover the address of DEBUG_BASE.  Because
269    of this complexity, we cache the value we find and return that value
270    on subsequent invocations.  Note there is no copy in the executable
271    symbol tables.
272
273    Irix 5 is basically like SunOS.
274
275    Note that we can assume nothing about the process state at the time
276    we need to find this address.  We may be stopped on the first instruc-
277    tion of the interpreter (C shared library), the first instruction of
278    the executable itself, or somewhere else entirely (if we attached
279    to the process for example).
280
281  */
282
283 static CORE_ADDR
284 locate_base (void)
285 {
286   struct minimal_symbol *msymbol;
287   CORE_ADDR address = 0;
288
289   msymbol = lookup_minimal_symbol (DEBUG_BASE, NULL, symfile_objfile);
290   if ((msymbol != NULL) && (SYMBOL_VALUE_ADDRESS (msymbol) != 0))
291     {
292       address = SYMBOL_VALUE_ADDRESS (msymbol);
293     }
294   return (address);
295 }
296
297 /*
298
299    LOCAL FUNCTION
300
301    disable_break -- remove the "mapping changed" breakpoint
302
303    SYNOPSIS
304
305    static int disable_break ()
306
307    DESCRIPTION
308
309    Removes the breakpoint that gets hit when the dynamic linker
310    completes a mapping change.
311
312  */
313
314 static int
315 disable_break (void)
316 {
317   int status = 1;
318
319
320   /* Note that breakpoint address and original contents are in our address
321      space, so we just need to write the original contents back. */
322
323   if (deprecated_remove_raw_breakpoint (base_breakpoint) != 0)
324     {
325       status = 0;
326     }
327
328   base_breakpoint = NULL;
329
330   /* Note that it is possible that we have stopped at a location that
331      is different from the location where we inserted our breakpoint.
332      On mips-irix, we can actually land in __dbx_init(), so we should
333      not check the PC against our breakpoint address here.  See procfs.c
334      for more details.  */
335
336   return (status);
337 }
338
339 /*
340
341    LOCAL FUNCTION
342
343    enable_break -- arrange for dynamic linker to hit breakpoint
344
345    SYNOPSIS
346
347    int enable_break (void)
348
349    DESCRIPTION
350
351    This functions inserts a breakpoint at the entry point of the
352    main executable, where all shared libraries are mapped in.
353  */
354
355 static int
356 enable_break (void)
357 {
358   if (symfile_objfile != NULL)
359     {
360       base_breakpoint
361         = deprecated_insert_raw_breakpoint (entry_point_address ());
362
363       if (base_breakpoint != NULL)
364         return 1;
365     }
366
367   return 0;
368 }
369
370 /*
371
372    LOCAL FUNCTION
373
374    irix_solib_create_inferior_hook -- shared library startup support
375
376    SYNOPSIS
377
378    void solib_create_inferior_hook ()
379
380    DESCRIPTION
381
382    When gdb starts up the inferior, it nurses it along (through the
383    shell) until it is ready to execute it's first instruction.  At this
384    point, this function gets called via expansion of the macro
385    SOLIB_CREATE_INFERIOR_HOOK.
386
387    For SunOS executables, this first instruction is typically the
388    one at "_start", or a similar text label, regardless of whether
389    the executable is statically or dynamically linked.  The runtime
390    startup code takes care of dynamically linking in any shared
391    libraries, once gdb allows the inferior to continue.
392
393    For SVR4 executables, this first instruction is either the first
394    instruction in the dynamic linker (for dynamically linked
395    executables) or the instruction at "start" for statically linked
396    executables.  For dynamically linked executables, the system
397    first exec's /lib/libc.so.N, which contains the dynamic linker,
398    and starts it running.  The dynamic linker maps in any needed
399    shared libraries, maps in the actual user executable, and then
400    jumps to "start" in the user executable.
401
402    For both SunOS shared libraries, and SVR4 shared libraries, we
403    can arrange to cooperate with the dynamic linker to discover the
404    names of shared libraries that are dynamically linked, and the
405    base addresses to which they are linked.
406
407    This function is responsible for discovering those names and
408    addresses, and saving sufficient information about them to allow
409    their symbols to be read at a later time.
410
411    FIXME
412
413    Between enable_break() and disable_break(), this code does not
414    properly handle hitting breakpoints which the user might have
415    set in the startup code or in the dynamic linker itself.  Proper
416    handling will probably have to wait until the implementation is
417    changed to use the "breakpoint handler function" method.
418
419    Also, what if child has exit()ed?  Must exit loop somehow.
420  */
421
422 static void
423 irix_solib_create_inferior_hook (void)
424 {
425   struct inferior *inf;
426   struct thread_info *tp;
427
428   if (!enable_break ())
429     {
430       warning (_("shared library handler failed to enable breakpoint"));
431       return;
432     }
433
434   /* Now run the target.  It will eventually hit the breakpoint, at
435      which point all of the libraries will have been mapped in and we
436      can go groveling around in the dynamic linker structures to find
437      out what we need to know about them. */
438
439   inf = current_inferior ();
440   tp = inferior_thread ();
441
442   clear_proceed_status ();
443
444   inf->stop_soon = STOP_QUIETLY;
445   tp->stop_signal = TARGET_SIGNAL_0;
446
447   do
448     {
449       target_resume (pid_to_ptid (-1), 0, tp->stop_signal);
450       wait_for_inferior (0);
451     }
452   while (tp->stop_signal != TARGET_SIGNAL_TRAP);
453
454   /* We are now either at the "mapping complete" breakpoint (or somewhere
455      else, a condition we aren't prepared to deal with anyway), so adjust
456      the PC as necessary after a breakpoint, disable the breakpoint, and
457      add any shared libraries that were mapped in. */
458
459   if (!disable_break ())
460     {
461       warning (_("shared library handler failed to disable breakpoint"));
462     }
463
464   /* solib_add will call reinit_frame_cache.
465      But we are stopped in the startup code and we might not have symbols
466      for the startup code, so heuristic_proc_start could be called
467      and will put out an annoying warning.
468      Delaying the resetting of stop_soon until after symbol loading
469      suppresses the warning.  */
470   solib_add ((char *) 0, 0, (struct target_ops *) 0, auto_solib_add);
471   inf->stop_soon = NO_STOP_QUIETLY;
472 }
473
474 /* LOCAL FUNCTION
475
476    current_sos -- build a list of currently loaded shared objects
477
478    SYNOPSIS
479
480    struct so_list *current_sos ()
481
482    DESCRIPTION
483
484    Build a list of `struct so_list' objects describing the shared
485    objects currently loaded in the inferior.  This list does not
486    include an entry for the main executable file.
487
488    Note that we only gather information directly available from the
489    inferior --- we don't examine any of the shared library files
490    themselves.  The declaration of `struct so_list' says which fields
491    we provide values for.  */
492
493 static struct so_list *
494 irix_current_sos (void)
495 {
496   CORE_ADDR lma;
497   char addr_buf[8];
498   struct so_list *head = 0;
499   struct so_list **link_ptr = &head;
500   int is_first = 1;
501   struct lm_info lm;
502
503   /* Make sure we've looked up the inferior's dynamic linker's base
504      structure.  */
505   if (!debug_base)
506     {
507       debug_base = locate_base ();
508
509       /* If we can't find the dynamic linker's base structure, this
510          must not be a dynamically linked executable.  Hmm.  */
511       if (!debug_base)
512         return 0;
513     }
514
515   read_memory (debug_base,
516                addr_buf,
517                gdbarch_addr_bit (target_gdbarch) / TARGET_CHAR_BIT);
518   lma = extract_mips_address (addr_buf,
519                               gdbarch_addr_bit (target_gdbarch)
520                                 / TARGET_CHAR_BIT);
521
522   while (lma)
523     {
524       lm = fetch_lm_info (lma);
525       if (!is_first)
526         {
527           int errcode;
528           char *name_buf;
529           int name_size;
530           struct so_list *new
531             = (struct so_list *) xmalloc (sizeof (struct so_list));
532           struct cleanup *old_chain = make_cleanup (xfree, new);
533
534           memset (new, 0, sizeof (*new));
535
536           new->lm_info = xmalloc (sizeof (struct lm_info));
537           make_cleanup (xfree, new->lm_info);
538
539           *new->lm_info = lm;
540
541           /* Extract this shared object's name.  */
542           name_size = lm.pathname_len;
543           if (name_size == 0)
544             name_size = SO_NAME_MAX_PATH_SIZE - 1;
545
546           if (name_size >= SO_NAME_MAX_PATH_SIZE)
547             {
548               name_size = SO_NAME_MAX_PATH_SIZE - 1;
549               warning
550                 ("current_sos: truncating name of %d characters to only %d characters",
551                  lm.pathname_len, name_size);
552             }
553
554           target_read_string (lm.pathname_addr, &name_buf,
555                               name_size, &errcode);
556           if (errcode != 0)
557             warning (_("Can't read pathname for load map: %s."),
558                        safe_strerror (errcode));
559           else
560             {
561               strncpy (new->so_name, name_buf, name_size);
562               new->so_name[name_size] = '\0';
563               xfree (name_buf);
564               strcpy (new->so_original_name, new->so_name);
565             }
566
567           new->next = 0;
568           *link_ptr = new;
569           link_ptr = &new->next;
570
571           discard_cleanups (old_chain);
572         }
573       is_first = 0;
574       lma = lm.next;
575     }
576
577   return head;
578 }
579
580 /*
581
582   LOCAL FUNCTION
583
584   irix_open_symbol_file_object
585
586   SYNOPSIS
587
588   void irix_open_symbol_file_object (void *from_tty)
589
590   DESCRIPTION
591
592   If no open symbol file, attempt to locate and open the main symbol
593   file.  On IRIX, this is the first link map entry.  If its name is
594   here, we can open it.  Useful when attaching to a process without
595   first loading its symbol file.
596
597   If FROM_TTYP dereferences to a non-zero integer, allow messages to
598   be printed.  This parameter is a pointer rather than an int because
599   open_symbol_file_object() is called via catch_errors() and
600   catch_errors() requires a pointer argument. */
601
602 static int
603 irix_open_symbol_file_object (void *from_ttyp)
604 {
605   CORE_ADDR lma;
606   char addr_buf[8];
607   struct lm_info lm;
608   struct cleanup *cleanups;
609   int errcode;
610   int from_tty = *(int *) from_ttyp;
611   char *filename;
612
613   if (symfile_objfile)
614     if (!query (_("Attempt to reload symbols from process? ")))
615       return 0;
616
617   if ((debug_base = locate_base ()) == 0)
618     return 0;                   /* failed somehow...  */
619
620   /* First link map member should be the executable.  */
621   read_memory (debug_base,
622                addr_buf,
623                gdbarch_addr_bit (target_gdbarch) / TARGET_CHAR_BIT);
624   lma = extract_mips_address (addr_buf,
625                               gdbarch_addr_bit (target_gdbarch)
626                                 / TARGET_CHAR_BIT);
627   if (lma == 0)
628     return 0;                   /* failed somehow...  */
629
630   lm = fetch_lm_info (lma);
631
632   if (lm.pathname_addr == 0)
633     return 0;                   /* No filename.  */
634
635   /* Now fetch the filename from target memory.  */
636   target_read_string (lm.pathname_addr, &filename, SO_NAME_MAX_PATH_SIZE - 1,
637                       &errcode);
638
639   if (errcode)
640     {
641       warning (_("failed to read exec filename from attached file: %s"),
642                safe_strerror (errcode));
643       return 0;
644     }
645
646   cleanups = make_cleanup (xfree, filename);
647   /* Have a pathname: read the symbol file.  */
648   symbol_file_add_main (filename, from_tty);
649
650   do_cleanups (cleanups);
651
652   return 1;
653 }
654
655
656 /*
657
658    LOCAL FUNCTION
659
660    irix_special_symbol_handling -- additional shared library symbol handling
661
662    SYNOPSIS
663
664    void irix_special_symbol_handling ()
665
666    DESCRIPTION
667
668    Once the symbols from a shared object have been loaded in the usual
669    way, we are called to do any system specific symbol handling that 
670    is needed.
671
672    For SunOS4, this consisted of grunging around in the dynamic
673    linkers structures to find symbol definitions for "common" symbols
674    and adding them to the minimal symbol table for the runtime common
675    objfile.
676
677    However, for IRIX, there's nothing to do.
678
679  */
680
681 static void
682 irix_special_symbol_handling (void)
683 {
684 }
685
686 /* Using the solist entry SO, relocate the addresses in SEC.  */
687
688 static void
689 irix_relocate_section_addresses (struct so_list *so,
690                                  struct section_table *sec)
691 {
692   sec->addr += so->lm_info->reloc_offset;
693   sec->endaddr += so->lm_info->reloc_offset;
694 }
695
696 /* Free the lm_info struct.  */
697
698 static void
699 irix_free_so (struct so_list *so)
700 {
701   xfree (so->lm_info);
702 }
703
704 /* Clear backend specific state.  */
705
706 static void
707 irix_clear_solib (void)
708 {
709   debug_base = 0;
710 }
711
712 /* Return 1 if PC lies in the dynamic symbol resolution code of the
713    run time loader.  */
714 static int
715 irix_in_dynsym_resolve_code (CORE_ADDR pc)
716 {
717   return 0;
718 }
719
720 struct target_so_ops irix_so_ops;
721
722 /* Provide a prototype to silence -Wmissing-prototypes.  */
723 extern initialize_file_ftype _initialize_irix_solib;
724
725 void
726 _initialize_irix_solib (void)
727 {
728   irix_so_ops.relocate_section_addresses = irix_relocate_section_addresses;
729   irix_so_ops.free_so = irix_free_so;
730   irix_so_ops.clear_solib = irix_clear_solib;
731   irix_so_ops.solib_create_inferior_hook = irix_solib_create_inferior_hook;
732   irix_so_ops.special_symbol_handling = irix_special_symbol_handling;
733   irix_so_ops.current_sos = irix_current_sos;
734   irix_so_ops.open_symbol_file_object = irix_open_symbol_file_object;
735   irix_so_ops.in_dynsym_resolve_code = irix_in_dynsym_resolve_code;
736 }