gdb/solib-osf.c

   1 /* Handle OSF/1, Digital UNIX, and Tru64 shared libraries
   2    for GDB, the GNU Debugger.
   3    Copyright (C) 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2007, 2008
   4    Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   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 3 of the License, or
  11    (at your option) any later version.
  12
  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.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 /* When handling shared libraries, GDB has to find out the pathnames
  22    of all shared libraries that are currently loaded (to read in their
  23    symbols) and where the shared libraries are loaded in memory
  24    (to relocate them properly from their prelinked addresses to the
  25    current load address).
  26
  27    Under OSF/1 there are two possibilities to get at this information:
  28
  29    1) Peek around in the runtime loader structures.
  30    These are not documented, and they are not defined in the system
  31    header files. The definitions below were obtained by experimentation,
  32    but they seem stable enough.
  33
  34    2) Use the libxproc.a library, which contains the equivalent ldr_*
  35    routines.  The library is documented in Tru64 5.x, but as of 5.1, it
  36    only allows a process to examine itself.  On earlier versions, it
  37    may require that the GDB executable be dynamically linked and that
  38    NAT_CLIBS include -lxproc -Wl,-expect_unresolved,ldr_process_context
  39    for GDB and all applications that are using libgdb.
  40
  41    We will use the peeking approach until libxproc.a works for other
  42    processes.  */
  43
  44 #include "defs.h"
  45
  46 #include <sys/types.h>
  47 #include <signal.h>
  48 #include "gdb_string.h"
  49
  50 #include "bfd.h"
  51 #include "symtab.h"
  52 #include "symfile.h"
  53 #include "objfiles.h"
  54 #include "target.h"
  55 #include "inferior.h"
  56 #include "gdbthread.h"
  57 #include "solist.h"
  58
  59 #ifdef USE_LDR_ROUTINES
  60 # include <loader.h>
  61 #endif
  62
  63 #ifndef USE_LDR_ROUTINES
  64 /* Definition of runtime loader structures, found by experimentation.  */
  65 #define RLD_CONTEXT_ADDRESS     0x3ffc0000000
  66
  67 /* Per-module information structure referenced by ldr_context_t.head.  */
  68
  69 typedef struct
  70   {
  71     CORE_ADDR next;
  72     CORE_ADDR previous;
  73     CORE_ADDR unknown1;
  74     CORE_ADDR module_name;
  75     CORE_ADDR modinfo_addr;     /* used by next_link_map_member() to detect
  76                                    the end of the shared module list */
  77     long module_id;
  78     CORE_ADDR unknown2;
  79     CORE_ADDR unknown3;
  80     long region_count;
  81     CORE_ADDR regioninfo_addr;
  82   }
  83 ldr_module_info_t;
  84
  85 /* Per-region structure referenced by ldr_module_info_t.regioninfo_addr.  */
  86
  87 typedef struct
  88   {
  89     long unknown1;
  90     CORE_ADDR regionname_addr;
  91     long protection;
  92     CORE_ADDR vaddr;
  93     CORE_ADDR mapaddr;
  94     long size;
  95     long unknown2[5];
  96   }
  97 ldr_region_info_t;
  98
  99 /* Structure at RLD_CONTEXT_ADDRESS specifying the start and finish addresses
 100    of the shared module list.  */
 101
 102 typedef struct
 103   {
 104     CORE_ADDR unknown1;
 105     CORE_ADDR unknown2;
 106     CORE_ADDR head;
 107     CORE_ADDR tail;
 108   }
 109 ldr_context_t;
 110 #endif   /* !USE_LDR_ROUTINES */
 111
 112 /* Per-section information, stored in struct lm_info.secs.  */
 113
 114 struct lm_sec
 115   {
 116     CORE_ADDR offset;           /* difference between default and actual
 117                                    virtual addresses of section .name */
 118     CORE_ADDR nameaddr;         /* address in inferior of section name */
 119     const char *name;           /* name of section, null if not fetched */
 120   };
 121
 122 /* Per-module information, stored in struct so_list.lm_info.  */
 123
 124 struct lm_info
 125   {
 126     int isloader;               /* whether the module is /sbin/loader */
 127     int nsecs;                  /* length of .secs */
 128     struct lm_sec secs[1];      /* variable-length array of sections, sorted
 129                                    by name */
 130   };
 131
 132 /* Context for iterating through the inferior's shared module list.  */
 133
 134 struct read_map_ctxt
 135   {
 136 #ifdef USE_LDR_ROUTINES
 137     ldr_process_t proc;
 138     ldr_module_t next;
 139 #else
 140     CORE_ADDR next;             /* next element in module list */
 141     CORE_ADDR tail;             /* last element in module list */
 142 #endif
 143   };
 144
 145 /* Forward declaration for this module's autoinit function.  */
 146
 147 extern void _initialize_osf_solib (void);
 148
 149 #ifdef USE_LDR_ROUTINES
 150 # if 0
 151 /* This routine is intended to be called by ldr_* routines to read memory from
 152    the current target.  Usage:
 153
 154      ldr_process = ldr_core_process ();
 155      ldr_set_core_reader (ldr_read_memory);
 156      ldr_xdetach (ldr_process);
 157      ldr_xattach (ldr_process);
 158
 159    ldr_core_process() and ldr_read_memory() are neither documented nor
 160    declared in system header files.  They work with OSF/1 2.x, and they might
 161    work with later versions as well.  */
 162
 163 static int
 164 ldr_read_memory (CORE_ADDR memaddr, char *myaddr, int len, int readstring)
 165 {
 166   int result;
 167   char *buffer;
 168
 169   if (readstring)
 170     {
 171       target_read_string (memaddr, &buffer, len, &result);
 172       if (result == 0)
 173         strcpy (myaddr, buffer);
 174       xfree (buffer);
 175     }
 176   else
 177     result = target_read_memory (memaddr, myaddr, len);
 178
 179   if (result != 0)
 180     result = -result;
 181   return result;
 182 }
 183 # endif   /* 0 */
 184 #endif   /* USE_LDR_ROUTINES */
 185
 186 /* Comparison for qsort() and bsearch(): return -1, 0, or 1 according to
 187    whether lm_sec *P1's name is lexically less than, equal to, or greater
 188    than that of *P2.  */
 189
 190 static int
 191 lm_sec_cmp (const void *p1, const void *p2)
 192 {
 193   const struct lm_sec *lms1 = p1, *lms2 = p2;
 194   return strcmp (lms1->name, lms2->name);
 195 }
 196
 197 /* Sort LMI->secs so that osf_relocate_section_addresses() can binary-search
 198    it.  */
 199
 200 static void
 201 lm_secs_sort (struct lm_info *lmi)
 202 {
 203   qsort (lmi->secs, lmi->nsecs, sizeof *lmi->secs, lm_sec_cmp);
 204 }
 205
 206 /* Populate name fields of LMI->secs.  */
 207
 208 static void
 209 fetch_sec_names (struct lm_info *lmi)
 210 {
 211 #ifndef USE_LDR_ROUTINES
 212   int i, errcode;
 213   struct lm_sec *lms;
 214   char *name;
 215
 216   for (i = 0; i < lmi->nsecs; i++)
 217     {
 218       lms = lmi->secs + i;
 219       target_read_string (lms->nameaddr, &name, PATH_MAX, &errcode);
 220       if (errcode != 0)
 221         {
 222           warning (_("unable to read shared sec name at 0x%lx"), lms->nameaddr);
 223           name = xstrdup ("");
 224         }
 225       lms->name = name;
 226     }
 227   lm_secs_sort (lmi);
 228 #endif
 229 }
 230
 231 /* target_so_ops callback.  Adjust SEC's addresses after it's been mapped into
 232    the process.  */
 233
 234 static void
 235 osf_relocate_section_addresses (struct so_list *so,
 236                                 struct section_table *sec)
 237 {
 238   struct lm_info *lmi;
 239   struct lm_sec lms_key, *lms;
 240
 241   /* Fetch SO's section names if we haven't done so already.  */
 242   lmi = so->lm_info;
 243   if (lmi->nsecs && !lmi->secs[0].name)
 244     fetch_sec_names (lmi);
 245
 246   /* Binary-search for offset information corresponding to SEC.  */
 247   lms_key.name = sec->the_bfd_section->name;
 248   lms = bsearch (&lms_key, lmi->secs, lmi->nsecs, sizeof *lms, lm_sec_cmp);
 249   if (lms)
 250     {
 251       sec->addr += lms->offset;
 252       sec->endaddr += lms->offset;
 253     }
 254 }
 255
 256 /* target_so_ops callback.  Free parts of SO allocated by this file.  */
 257
 258 static void
 259 osf_free_so (struct so_list *so)
 260 {
 261   int i;
 262   const char *name;
 263
 264   for (i = 0; i < so->lm_info->nsecs; i++)
 265     {
 266       name = so->lm_info->secs[i].name;
 267       if (name)
 268         xfree ((void *) name);
 269     }
 270   xfree (so->lm_info);
 271 }
 272
 273 /* target_so_ops callback.  Discard information accumulated by this file and
 274    not freed by osf_free_so().  */
 275
 276 static void
 277 osf_clear_solib (void)
 278 {
 279   return;
 280 }
 281
 282 /* target_so_ops callback.  Prepare to handle shared libraries after the
 283    inferior process has been created but before it's executed any
 284    instructions.
 285
 286    For a statically bound executable, the inferior's first instruction is the
 287    one at "_start", or a similar text label. No further processing is needed
 288    in that case.
 289
 290    For a dynamically bound executable, this first instruction is somewhere
 291    in the rld, and the actual user executable is not yet mapped in.
 292    We continue the inferior again, rld then maps in the actual user
 293    executable and any needed shared libraries and then sends
 294    itself a SIGTRAP.
 295
 296    At that point we discover the names of all shared libraries and
 297    read their symbols in.
 298
 299    FIXME
 300
 301    This code does not properly handle hitting breakpoints which the
 302    user might have set in the rld itself.  Proper handling would have
 303    to check if the SIGTRAP happened due to a kill call.
 304
 305    Also, what if child has exit()ed?  Must exit loop somehow.  */
 306
 307 static void
 308 osf_solib_create_inferior_hook (void)
 309 {
 310   struct thread_info *tp;
 311
 312   /* If we are attaching to the inferior, the shared libraries
 313      have already been mapped, so nothing more to do.  */
 314   if (attach_flag)
 315     return;
 316
 317   /* Nothing to do for statically bound executables.  */
 318
 319   if (symfile_objfile == NULL
 320       || symfile_objfile->obfd == NULL
 321       || ((bfd_get_file_flags (symfile_objfile->obfd) & DYNAMIC) == 0))
 322     return;
 323
 324   /* Now run the target.  It will eventually get a SIGTRAP, at
 325      which point all of the libraries will have been mapped in and we
 326      can go groveling around in the rld structures to find
 327      out what we need to know about them.
 328
 329      If debugging from a core file, we cannot resume the execution
 330      of the inferior.  But this is actually not an issue, because
 331      shared libraries have already been mapped anyways, which means
 332      we have nothing more to do.  */
 333   if (!target_can_run (&current_target))
 334     return;
 335
 336   tp = inferior_thread ();
 337   clear_proceed_status ();
 338   stop_soon = STOP_QUIETLY;
 339   tp->stop_signal = TARGET_SIGNAL_0;
 340   do
 341     {
 342       target_resume (minus_one_ptid, 0, tp->stop_signal);
 343       wait_for_inferior (0);
 344     }
 345   while (tp->stop_signal != TARGET_SIGNAL_TRAP);
 346
 347   /*  solib_add will call reinit_frame_cache.
 348      But we are stopped in the runtime loader and we do not have symbols
 349      for the runtime loader. So heuristic_proc_start will be called
 350      and will put out an annoying warning.
 351      Delaying the resetting of stop_soon until after symbol loading
 352      suppresses the warning.  */
 353   solib_add ((char *) 0, 0, (struct target_ops *) 0, auto_solib_add);
 354   stop_soon = NO_STOP_QUIETLY;
 355 }
 356
 357 /* target_so_ops callback.  Do additional symbol handling, lookup, etc. after
 358    symbols for a shared object have been loaded.  */
 359
 360 static void
 361 osf_special_symbol_handling (void)
 362 {
 363   return;
 364 }
 365
 366 /* Initialize CTXT in preparation for iterating through the inferior's module
 367    list using read_map().  Return success.  */
 368
 369 static int
 370 open_map (struct read_map_ctxt *ctxt)
 371 {
 372 #ifdef USE_LDR_ROUTINES
 373   /* Note: As originally written, ldr_my_process() was used to obtain
 374      the value for ctxt->proc.  This is incorrect, however, since
 375      ldr_my_process() retrieves the "unique identifier" associated
 376      with the current process (i.e. GDB) and not the one being
 377      debugged.  Presumably, the pid of the process being debugged is
 378      compatible with the "unique identifier" used by the ldr_
 379      routines, so we use that.  */
 380   ctxt->proc = ptid_get_pid (inferior_ptid);
 381   if (ldr_xattach (ctxt->proc) != 0)
 382     return 0;
 383   ctxt->next = LDR_NULL_MODULE;
 384 #else
 385   CORE_ADDR ldr_context_addr, prev, next;
 386   ldr_context_t ldr_context;
 387
 388   if (target_read_memory ((CORE_ADDR) RLD_CONTEXT_ADDRESS,
 389                           (char *) &ldr_context_addr,
 390                           sizeof (CORE_ADDR)) != 0)
 391     return 0;
 392   if (target_read_memory (ldr_context_addr,
 393                           (char *) &ldr_context,
 394                           sizeof (ldr_context_t)) != 0)
 395     return 0;
 396   ctxt->next = ldr_context.head;
 397   ctxt->tail = ldr_context.tail;
 398 #endif
 399   return 1;
 400 }
 401
 402 /* Initialize SO to have module NAME, /sbin/loader indicator ISLOADR, and
 403    space for NSECS sections.  */
 404
 405 static void
 406 init_so (struct so_list *so, char *name, int isloader, int nsecs)
 407 {
 408   int namelen, i;
 409
 410   /* solib.c requires various fields to be initialized to 0.  */
 411   memset (so, 0, sizeof *so);
 412
 413   /* Copy the name.  */
 414   namelen = strlen (name);
 415   if (namelen >= SO_NAME_MAX_PATH_SIZE)
 416     namelen = SO_NAME_MAX_PATH_SIZE - 1;
 417
 418   memcpy (so->so_original_name, name, namelen);
 419   so->so_original_name[namelen] = '\0';
 420   memcpy (so->so_name, so->so_original_name, namelen + 1);
 421
 422   /* Allocate section space.  */
 423   so->lm_info = xmalloc ((unsigned) &(((struct lm_info *)0)->secs) +
 424                          nsecs * sizeof *so->lm_info);
 425   so->lm_info->isloader = isloader;
 426   so->lm_info->nsecs = nsecs;
 427   for (i = 0; i < nsecs; i++)
 428     so->lm_info->secs[i].name = NULL;
 429 }
 430
 431 /* Initialize SO's section SECIDX with name address NAMEADDR, name string
 432    NAME, default virtual address VADDR, and actual virtual address
 433    MAPADDR.  */
 434
 435 static void
 436 init_sec (struct so_list *so, int secidx, CORE_ADDR nameaddr,
 437           const char *name, CORE_ADDR vaddr, CORE_ADDR mapaddr)
 438 {
 439   struct lm_sec *lms;
 440
 441   lms = so->lm_info->secs + secidx;
 442   lms->nameaddr = nameaddr;
 443   lms->name = name;
 444   lms->offset = mapaddr - vaddr;
 445 }
 446
 447 /* If there are more elements starting at CTXT in inferior's module list,
 448    store the next element in SO, advance CTXT to the next element, and return
 449    1, else return 0.  */
 450
 451 static int
 452 read_map (struct read_map_ctxt *ctxt, struct so_list *so)
 453 {
 454   ldr_module_info_t minf;
 455   ldr_region_info_t rinf;
 456
 457 #ifdef USE_LDR_ROUTINES
 458   size_t size;
 459   ldr_region_t i;
 460
 461   /* Retrieve the next element.  */
 462   if (ldr_next_module (ctxt->proc, &ctxt->next) != 0)
 463     return 0;
 464   if (ctxt->next == LDR_NULL_MODULE)
 465     return 0;
 466   if (ldr_inq_module (ctxt->proc, ctxt->next, &minf, sizeof minf, &size) != 0)
 467     return 0;
 468
 469   /* Initialize the module name and section count.  */
 470   init_so (so, minf.lmi_name, 0, minf.lmi_nregion);
 471
 472   /* Retrieve section names and offsets.  */
 473   for (i = 0; i < minf.lmi_nregion; i++)
 474     {
 475       if (ldr_inq_region (ctxt->proc, ctxt->next, i, &rinf,
 476                           sizeof rinf, &size) != 0)
 477         goto err;
 478       init_sec (so, (int) i, 0, xstrdup (rinf.lri_name),
 479                 (CORE_ADDR) rinf.lri_vaddr, (CORE_ADDR) rinf.lri_mapaddr);
 480     }
 481   lm_secs_sort (so->lm_info);
 482 #else
 483   char *name;
 484   int errcode, i;
 485
 486   /* Retrieve the next element.  */
 487   if (!ctxt->next)
 488     return 0;
 489   if (target_read_memory (ctxt->next, (char *) &minf, sizeof minf) != 0)
 490     return 0;
 491   if (ctxt->next == ctxt->tail)
 492     ctxt->next = 0;
 493   else
 494     ctxt->next = minf.next;
 495
 496   /* Initialize the module name and section count.  */
 497   target_read_string (minf.module_name, &name, PATH_MAX, &errcode);
 498   if (errcode != 0)
 499     return 0;
 500   init_so (so, name, !minf.modinfo_addr, minf.region_count);
 501   xfree (name);
 502
 503   /* Retrieve section names and offsets.  */
 504   for (i = 0; i < minf.region_count; i++)
 505     {
 506       if (target_read_memory (minf.regioninfo_addr + i * sizeof rinf,
 507                               (char *) &rinf, sizeof rinf) != 0)
 508         goto err;
 509       init_sec (so, i, rinf.regionname_addr, NULL, rinf.vaddr, rinf.mapaddr);
 510     }
 511 #endif   /* !USE_LDR_ROUTINES */
 512   return 1;
 513
 514  err:
 515   osf_free_so (so);
 516   return 0;
 517 }
 518
 519 /* Free resources allocated by open_map (CTXT).  */
 520
 521 static void
 522 close_map (struct read_map_ctxt *ctxt)
 523 {
 524 #ifdef USE_LDR_ROUTINES
 525   ldr_xdetach (ctxt->proc);
 526 #endif
 527 }
 528
 529 /* target_so_ops callback.  Return a list of shared objects currently loaded
 530    in the inferior.  */
 531
 532 static struct so_list *
 533 osf_current_sos (void)
 534 {
 535   struct so_list *head = NULL, *tail, *newtail, so;
 536   struct read_map_ctxt ctxt;
 537   int skipped_main;
 538
 539   if (!open_map (&ctxt))
 540     return NULL;
 541
 542   /* Read subsequent elements.  */
 543   for (skipped_main = 0;;)
 544     {
 545       if (!read_map (&ctxt, &so))
 546         break;
 547
 548       /* Skip the main program module, which is first in the list after
 549          /sbin/loader.  */
 550       if (!so.lm_info->isloader && !skipped_main)
 551         {
 552           osf_free_so (&so);
 553           skipped_main = 1;
 554           continue;
 555         }
 556
 557       newtail = xmalloc (sizeof *newtail);
 558       if (!head)
 559         head = newtail;
 560       else
 561         tail->next = newtail;
 562       tail = newtail;
 563
 564       memcpy (tail, &so, sizeof so);
 565       tail->next = NULL;
 566     }
 567
 568   close_map (&ctxt);
 569   return head;
 570 }
 571
 572 /* target_so_ops callback.  Attempt to locate and open the main symbol
 573    file.  */
 574
 575 static int
 576 osf_open_symbol_file_object (void *from_ttyp)
 577 {
 578   struct read_map_ctxt ctxt;
 579   struct so_list so;
 580   int found;
 581
 582   if (symfile_objfile)
 583     if (!query ("Attempt to reload symbols from process? "))
 584       return 0;
 585
 586   /* The first module after /sbin/loader is the main program.  */
 587   if (!open_map (&ctxt))
 588     return 0;
 589   for (found = 0; !found;)
 590     {
 591       if (!read_map (&ctxt, &so))
 592         break;
 593       found = !so.lm_info->isloader;
 594       osf_free_so (&so);
 595     }
 596   close_map (&ctxt);
 597
 598   if (found)
 599     symbol_file_add_main (so.so_name, *(int *) from_ttyp);
 600   return found;
 601 }
 602
 603 /* target_so_ops callback.  Return whether PC is in the dynamic linker.  */
 604
 605 static int
 606 osf_in_dynsym_resolve_code (CORE_ADDR pc)
 607 {
 608   /* This function currently always return False. This is a temporary
 609      solution which only consequence is to introduce a minor incovenience
 610      for the user: When stepping inside a subprogram located in a shared
 611      library, gdb might stop inside the dynamic loader code instead of
 612      inside the subprogram itself. See the explanations in infrun.c about
 613      the in_solib_dynsym_resolve_code() function for more details. */
 614   return 0;
 615 }
 616
 617 static struct target_so_ops osf_so_ops;
 618
 619 void
 620 _initialize_osf_solib (void)
 621 {
 622   osf_so_ops.relocate_section_addresses = osf_relocate_section_addresses;
 623   osf_so_ops.free_so = osf_free_so;
 624   osf_so_ops.clear_solib = osf_clear_solib;
 625   osf_so_ops.solib_create_inferior_hook = osf_solib_create_inferior_hook;
 626   osf_so_ops.special_symbol_handling = osf_special_symbol_handling;
 627   osf_so_ops.current_sos = osf_current_sos;
 628   osf_so_ops.open_symbol_file_object = osf_open_symbol_file_object;
 629   osf_so_ops.in_dynsym_resolve_code = osf_in_dynsym_resolve_code;
 630
 631   /* FIXME: Don't do this here.  *_gdbarch_init() should set so_ops. */
 632   current_target_so_ops = &osf_so_ops;
 633 }