Updated copyright notices for most files.
[external/binutils.git] / gdb / solib.c
1 /* Handle shared libraries for GDB, the GNU Debugger.
2
3    Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4    2000, 2001, 2002, 2003, 2005, 2006, 2007, 2008, 2009
5    Free Software Foundation, Inc.
6
7    This file is part of GDB.
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
21
22 #include "defs.h"
23
24 #include <sys/types.h>
25 #include <fcntl.h>
26 #include "gdb_string.h"
27 #include "symtab.h"
28 #include "bfd.h"
29 #include "symfile.h"
30 #include "objfiles.h"
31 #include "exceptions.h"
32 #include "gdbcore.h"
33 #include "command.h"
34 #include "target.h"
35 #include "frame.h"
36 #include "gdb_regex.h"
37 #include "inferior.h"
38 #include "environ.h"
39 #include "language.h"
40 #include "gdbcmd.h"
41 #include "completer.h"
42 #include "filenames.h"          /* for DOSish file names */
43 #include "exec.h"
44 #include "solist.h"
45 #include "observer.h"
46 #include "readline/readline.h"
47 #include "remote.h"
48
49 /* Architecture-specific operations.  */
50
51 /* Per-architecture data key.  */
52 static struct gdbarch_data *solib_data;
53
54 static void *
55 solib_init (struct obstack *obstack)
56 {
57   struct target_so_ops **ops;
58
59   ops = OBSTACK_ZALLOC (obstack, struct target_so_ops *);
60   *ops = current_target_so_ops;
61   return ops;
62 }
63
64 static struct target_so_ops *
65 solib_ops (struct gdbarch *gdbarch)
66 {
67   struct target_so_ops **ops = gdbarch_data (gdbarch, solib_data);
68   return *ops;
69 }
70
71 /* Set the solib operations for GDBARCH to NEW_OPS.  */
72
73 void
74 set_solib_ops (struct gdbarch *gdbarch, struct target_so_ops *new_ops)
75 {
76   struct target_so_ops **ops = gdbarch_data (gdbarch, solib_data);
77   *ops = new_ops;
78 }
79 \f
80
81 /* external data declarations */
82
83 /* FIXME: gdbarch needs to control this variable, or else every
84    configuration needs to call set_solib_ops.  */
85 struct target_so_ops *current_target_so_ops;
86
87 /* local data declarations */
88
89 static struct so_list *so_list_head;    /* List of known shared objects */
90
91 /* Local function prototypes */
92
93 /* If non-empty, this is a search path for loading non-absolute shared library
94    symbol files.  This takes precedence over the environment variables PATH
95    and LD_LIBRARY_PATH.  */
96 static char *solib_search_path = NULL;
97 static void
98 show_solib_search_path (struct ui_file *file, int from_tty,
99                         struct cmd_list_element *c, const char *value)
100 {
101   fprintf_filtered (file, _("\
102 The search path for loading non-absolute shared library symbol files is %s.\n"),
103                     value);
104 }
105
106 /*
107
108    GLOBAL FUNCTION
109
110    solib_bfd_open -- Find a shared library file and open BFD for it.
111
112    SYNOPSIS
113
114    struct bfd *solib_open (char *in_pathname);
115
116    DESCRIPTION
117
118    Global variable GDB_SYSROOT is used as a prefix directory
119    to search for shared libraries if they have an absolute path.
120
121    Global variable SOLIB_SEARCH_PATH is used as a prefix directory
122    (or set of directories, as in LD_LIBRARY_PATH) to search for all
123    shared libraries if not found in GDB_SYSROOT.
124
125    Search algorithm:
126    * If there is a gdb_sysroot and path is absolute:
127    *   Search for gdb_sysroot/path.
128    * else
129    *   Look for it literally (unmodified).
130    * Look in SOLIB_SEARCH_PATH.
131    * If available, use target defined search function.
132    * If gdb_sysroot is NOT set, perform the following two searches:
133    *   Look in inferior's $PATH.
134    *   Look in inferior's $LD_LIBRARY_PATH.
135    *   
136    * The last check avoids doing this search when targetting remote
137    * machines since gdb_sysroot will almost always be set.
138
139    RETURNS
140
141    BFD file handle for opened solib; throws error on failure.  */
142
143 bfd *
144 solib_bfd_open (char *in_pathname)
145 {
146   struct target_so_ops *ops = solib_ops (target_gdbarch);
147   int found_file = -1;
148   char *temp_pathname = NULL;
149   char *p = in_pathname;
150   int gdb_sysroot_is_empty;
151   bfd *abfd;
152
153   gdb_sysroot_is_empty = (gdb_sysroot == NULL || *gdb_sysroot == 0);
154
155   if (! IS_ABSOLUTE_PATH (in_pathname) || gdb_sysroot_is_empty)
156     temp_pathname = in_pathname;
157   else
158     {
159       int prefix_len = strlen (gdb_sysroot);
160
161       /* Remove trailing slashes from absolute prefix.  */
162       while (prefix_len > 0
163              && IS_DIR_SEPARATOR (gdb_sysroot[prefix_len - 1]))
164         prefix_len--;
165
166       /* Cat the prefixed pathname together.  */
167       temp_pathname = alloca (prefix_len + strlen (in_pathname) + 1);
168       strncpy (temp_pathname, gdb_sysroot, prefix_len);
169       temp_pathname[prefix_len] = '\0';
170       strcat (temp_pathname, in_pathname);
171     }
172
173   /* Handle remote files.  */
174   if (remote_filename_p (temp_pathname))
175     {
176       temp_pathname = xstrdup (temp_pathname);
177       abfd = remote_bfd_open (temp_pathname, gnutarget);
178       if (!abfd)
179         {
180           make_cleanup (xfree, temp_pathname);
181           error (_("Could not open `%s' as an executable file: %s"),
182                  temp_pathname, bfd_errmsg (bfd_get_error ()));
183         }
184
185       if (!bfd_check_format (abfd, bfd_object))
186         {
187           bfd_close (abfd);
188           make_cleanup (xfree, temp_pathname);
189           error (_("`%s': not in executable format: %s"),
190                  temp_pathname, bfd_errmsg (bfd_get_error ()));
191         }
192
193       return abfd;
194     }
195
196   /* Now see if we can open it.  */
197   found_file = open (temp_pathname, O_RDONLY | O_BINARY, 0);
198
199   /* We try to find the library in various ways.  After each attempt
200      (except for the one above), either found_file >= 0 and
201      temp_pathname is a malloc'd string, or found_file < 0 and
202      temp_pathname does not point to storage that needs to be
203      freed.  */
204
205     if (found_file < 0)
206       temp_pathname = NULL;
207     else
208       temp_pathname = xstrdup (temp_pathname);
209
210   /* If the search in gdb_sysroot failed, and the path name is
211      absolute at this point, make it relative.  (openp will try and open the
212      file according to its absolute path otherwise, which is not what we want.)
213      Affects subsequent searches for this solib.  */
214   if (found_file < 0 && IS_ABSOLUTE_PATH (in_pathname))
215     {
216       /* First, get rid of any drive letters etc.  */
217       while (!IS_DIR_SEPARATOR (*in_pathname))
218         in_pathname++;
219
220       /* Next, get rid of all leading dir separators.  */
221       while (IS_DIR_SEPARATOR (*in_pathname))
222         in_pathname++;
223     }
224   
225   /* If not found, search the solib_search_path (if any).  */
226   if (found_file < 0 && solib_search_path != NULL)
227     found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
228                         in_pathname, O_RDONLY | O_BINARY, 0, &temp_pathname);
229   
230   /* If not found, next search the solib_search_path (if any) for the basename
231      only (ignoring the path).  This is to allow reading solibs from a path
232      that differs from the opened path.  */
233   if (found_file < 0 && solib_search_path != NULL)
234     found_file = openp (solib_search_path, OPF_TRY_CWD_FIRST,
235                         lbasename (in_pathname), O_RDONLY | O_BINARY, 0,
236                         &temp_pathname);
237
238   /* If not found, try to use target supplied solib search method */
239   if (found_file < 0 && ops->find_and_open_solib)
240     found_file = ops->find_and_open_solib (in_pathname, O_RDONLY | O_BINARY,
241                                            &temp_pathname);
242
243   /* If not found, next search the inferior's $PATH environment variable. */
244   if (found_file < 0 && gdb_sysroot_is_empty)
245     found_file = openp (get_in_environ (inferior_environ, "PATH"),
246                         OPF_TRY_CWD_FIRST, in_pathname, O_RDONLY | O_BINARY, 0,
247                         &temp_pathname);
248
249   /* If not found, next search the inferior's $LD_LIBRARY_PATH 
250      environment variable. */
251   if (found_file < 0 && gdb_sysroot_is_empty)
252     found_file = openp (get_in_environ (inferior_environ, "LD_LIBRARY_PATH"),
253                         OPF_TRY_CWD_FIRST, in_pathname, O_RDONLY | O_BINARY, 0,
254                         &temp_pathname);
255
256   /* Done.  If still not found, error.  */
257   if (found_file < 0)
258     perror_with_name (in_pathname);
259
260   /* Leave temp_pathname allocated.  abfd->name will point to it.  */
261   abfd = bfd_fopen (temp_pathname, gnutarget, FOPEN_RB, found_file);
262   if (!abfd)
263     {
264       close (found_file);
265       make_cleanup (xfree, temp_pathname);
266       error (_("Could not open `%s' as an executable file: %s"),
267              temp_pathname, bfd_errmsg (bfd_get_error ()));
268     }
269
270   if (!bfd_check_format (abfd, bfd_object))
271     {
272       bfd_close (abfd);
273       make_cleanup (xfree, temp_pathname);
274       error (_("`%s': not in executable format: %s"),
275              temp_pathname, bfd_errmsg (bfd_get_error ()));
276     }
277
278   bfd_set_cacheable (abfd, 1);
279   return abfd;
280 }
281
282
283 /*
284
285    LOCAL FUNCTION
286
287    solib_map_sections -- open bfd and build sections for shared lib
288
289    SYNOPSIS
290
291    static int solib_map_sections (struct so_list *so)
292
293    DESCRIPTION
294
295    Given a pointer to one of the shared objects in our list
296    of mapped objects, use the recorded name to open a bfd
297    descriptor for the object, build a section table, and then
298    relocate all the section addresses by the base address at
299    which the shared object was mapped.
300
301    FIXMES
302
303    In most (all?) cases the shared object file name recorded in the
304    dynamic linkage tables will be a fully qualified pathname.  For
305    cases where it isn't, do we really mimic the systems search
306    mechanism correctly in the below code (particularly the tilde
307    expansion stuff?).
308  */
309
310 static int
311 solib_map_sections (void *arg)
312 {
313   struct so_list *so = (struct so_list *) arg;  /* catch_errors bogon */
314   char *filename;
315   struct section_table *p;
316   struct cleanup *old_chain;
317   bfd *abfd;
318
319   filename = tilde_expand (so->so_name);
320   old_chain = make_cleanup (xfree, filename);
321   abfd = solib_bfd_open (filename);
322   do_cleanups (old_chain);
323
324   /* Leave bfd open, core_xfer_memory and "info files" need it.  */
325   so->abfd = abfd;
326
327   /* copy full path name into so_name, so that later symbol_file_add
328      can find it */
329   if (strlen (bfd_get_filename (abfd)) >= SO_NAME_MAX_PATH_SIZE)
330     error (_("Shared library file name is too long."));
331   strcpy (so->so_name, bfd_get_filename (abfd));
332
333   if (build_section_table (abfd, &so->sections, &so->sections_end))
334     {
335       error (_("Can't find the file sections in `%s': %s"),
336              bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
337     }
338
339   for (p = so->sections; p < so->sections_end; p++)
340     {
341       struct target_so_ops *ops = solib_ops (target_gdbarch);
342
343       /* Relocate the section binding addresses as recorded in the shared
344          object's file by the base address to which the object was actually
345          mapped. */
346       ops->relocate_section_addresses (so, p);
347
348       /* If the target didn't provide information about the address
349          range of the shared object, assume we want the location of
350          the .text section.  */
351       if (so->addr_low == 0 && so->addr_high == 0
352           && strcmp (p->the_bfd_section->name, ".text") == 0)
353         {
354           so->addr_low = p->addr;
355           so->addr_high = p->endaddr;
356         }
357     }
358
359   return (1);
360 }
361
362 /* LOCAL FUNCTION
363
364    free_so --- free a `struct so_list' object
365
366    SYNOPSIS
367
368    void free_so (struct so_list *so)
369
370    DESCRIPTION
371
372    Free the storage associated with the `struct so_list' object SO.
373    If we have opened a BFD for SO, close it.  
374
375    The caller is responsible for removing SO from whatever list it is
376    a member of.  If we have placed SO's sections in some target's
377    section table, the caller is responsible for removing them.
378
379    This function doesn't mess with objfiles at all.  If there is an
380    objfile associated with SO that needs to be removed, the caller is
381    responsible for taking care of that.  */
382
383 void
384 free_so (struct so_list *so)
385 {
386   struct target_so_ops *ops = solib_ops (target_gdbarch);
387   char *bfd_filename = 0;
388
389   if (so->sections)
390     xfree (so->sections);
391       
392   if (so->abfd)
393     {
394       bfd_filename = bfd_get_filename (so->abfd);
395       if (! bfd_close (so->abfd))
396         warning (_("cannot close \"%s\": %s"),
397                  bfd_filename, bfd_errmsg (bfd_get_error ()));
398     }
399
400   if (bfd_filename)
401     xfree (bfd_filename);
402
403   ops->free_so (so);
404
405   xfree (so);
406 }
407
408
409 /* Return address of first so_list entry in master shared object list.  */
410 struct so_list *
411 master_so_list (void)
412 {
413   return so_list_head;
414 }
415
416
417 /* A small stub to get us past the arg-passing pinhole of catch_errors.  */
418
419 static int
420 symbol_add_stub (void *arg)
421 {
422   struct so_list *so = (struct so_list *) arg;  /* catch_errs bogon */
423   struct section_addr_info *sap;
424
425   /* Have we already loaded this shared object?  */
426   ALL_OBJFILES (so->objfile)
427     {
428       if (strcmp (so->objfile->name, so->so_name) == 0)
429         return 1;
430     }
431
432   sap = build_section_addr_info_from_section_table (so->sections,
433                                                     so->sections_end);
434
435   so->objfile = symbol_file_add (so->so_name, so->from_tty,
436                                  sap, 0, OBJF_SHARED);
437   free_section_addr_info (sap);
438
439   return (1);
440 }
441
442 /* Read in symbols for shared object SO.  If FROM_TTY is non-zero, be
443    chatty about it.  Return non-zero if any symbols were actually
444    loaded.  */
445
446 int
447 solib_read_symbols (struct so_list *so, int from_tty)
448 {
449   if (so->symbols_loaded)
450     {
451       if (from_tty)
452         printf_unfiltered (_("Symbols already loaded for %s\n"), so->so_name);
453     }
454   else if (so->abfd == NULL)
455     {
456       if (from_tty)
457         printf_unfiltered (_("Symbol file not found for %s\n"), so->so_name);
458     }
459   else
460     {
461       if (catch_errors (symbol_add_stub, so,
462                         "Error while reading shared library symbols:\n",
463                         RETURN_MASK_ALL))
464         {
465           if (from_tty && print_symbol_loading)
466             printf_unfiltered (_("Loaded symbols for %s\n"), so->so_name);
467           so->symbols_loaded = 1;
468           return 1;
469         }
470     }
471
472   return 0;
473 }
474
475 /* LOCAL FUNCTION
476
477    update_solib_list --- synchronize GDB's shared object list with inferior's
478
479    SYNOPSIS
480
481    void update_solib_list (int from_tty, struct target_ops *TARGET)
482
483    Extract the list of currently loaded shared objects from the
484    inferior, and compare it with the list of shared objects currently
485    in GDB's so_list_head list.  Edit so_list_head to bring it in sync
486    with the inferior's new list.
487
488    If we notice that the inferior has unloaded some shared objects,
489    free any symbolic info GDB had read about those shared objects.
490
491    Don't load symbolic info for any new shared objects; just add them
492    to the list, and leave their symbols_loaded flag clear.
493
494    If FROM_TTY is non-null, feel free to print messages about what
495    we're doing.
496
497    If TARGET is non-null, add the sections of all new shared objects
498    to TARGET's section table.  Note that this doesn't remove any
499    sections for shared objects that have been unloaded, and it
500    doesn't check to see if the new shared objects are already present in
501    the section table.  But we only use this for core files and
502    processes we've just attached to, so that's okay.  */
503
504 static void
505 update_solib_list (int from_tty, struct target_ops *target)
506 {
507   struct target_so_ops *ops = solib_ops (target_gdbarch);
508   struct so_list *inferior = ops->current_sos();
509   struct so_list *gdb, **gdb_link;
510
511   /* We can reach here due to changing solib-search-path or the
512      sysroot, before having any inferior.  */
513   if (target_has_execution && !ptid_equal (inferior_ptid, null_ptid))
514     {
515       struct inferior *inf = current_inferior ();
516
517       /* If we are attaching to a running process for which we
518          have not opened a symbol file, we may be able to get its
519          symbols now!  */
520       if (inf->attach_flag && symfile_objfile == NULL)
521         catch_errors (ops->open_symbol_file_object, &from_tty,
522                       "Error reading attached process's symbol file.\n",
523                       RETURN_MASK_ALL);
524     }
525
526   /* GDB and the inferior's dynamic linker each maintain their own
527      list of currently loaded shared objects; we want to bring the
528      former in sync with the latter.  Scan both lists, seeing which
529      shared objects appear where.  There are three cases:
530
531      - A shared object appears on both lists.  This means that GDB
532      knows about it already, and it's still loaded in the inferior.
533      Nothing needs to happen.
534
535      - A shared object appears only on GDB's list.  This means that
536      the inferior has unloaded it.  We should remove the shared
537      object from GDB's tables.
538
539      - A shared object appears only on the inferior's list.  This
540      means that it's just been loaded.  We should add it to GDB's
541      tables.
542
543      So we walk GDB's list, checking each entry to see if it appears
544      in the inferior's list too.  If it does, no action is needed, and
545      we remove it from the inferior's list.  If it doesn't, the
546      inferior has unloaded it, and we remove it from GDB's list.  By
547      the time we're done walking GDB's list, the inferior's list
548      contains only the new shared objects, which we then add.  */
549
550   gdb = so_list_head;
551   gdb_link = &so_list_head;
552   while (gdb)
553     {
554       struct so_list *i = inferior;
555       struct so_list **i_link = &inferior;
556
557       /* Check to see whether the shared object *gdb also appears in
558          the inferior's current list.  */
559       while (i)
560         {
561           if (ops->same)
562             {
563               if (ops->same (gdb, i))
564                 break;
565             }
566           else
567             {
568               if (! strcmp (gdb->so_original_name, i->so_original_name))
569                 break;        
570             }
571
572           i_link = &i->next;
573           i = *i_link;
574         }
575
576       /* If the shared object appears on the inferior's list too, then
577          it's still loaded, so we don't need to do anything.  Delete
578          it from the inferior's list, and leave it on GDB's list.  */
579       if (i)
580         {
581           *i_link = i->next;
582           free_so (i);
583           gdb_link = &gdb->next;
584           gdb = *gdb_link;
585         }
586
587       /* If it's not on the inferior's list, remove it from GDB's tables.  */
588       else
589         {
590           /* Notify any observer that the shared object has been
591              unloaded before we remove it from GDB's tables.  */
592           observer_notify_solib_unloaded (gdb);
593
594           *gdb_link = gdb->next;
595
596           /* Unless the user loaded it explicitly, free SO's objfile.  */
597           if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED))
598             free_objfile (gdb->objfile);
599
600           /* Some targets' section tables might be referring to
601              sections from so->abfd; remove them.  */
602           remove_target_sections (gdb->abfd);
603
604           free_so (gdb);
605           gdb = *gdb_link;
606         }
607     }
608
609   /* Now the inferior's list contains only shared objects that don't
610      appear in GDB's list --- those that are newly loaded.  Add them
611      to GDB's shared object list.  */
612   if (inferior)
613     {
614       struct so_list *i;
615
616       /* Add the new shared objects to GDB's list.  */
617       *gdb_link = inferior;
618
619       /* Fill in the rest of each of the `struct so_list' nodes.  */
620       for (i = inferior; i; i = i->next)
621         {
622           i->from_tty = from_tty;
623
624           /* Fill in the rest of the `struct so_list' node.  */
625           catch_errors (solib_map_sections, i,
626                         "Error while mapping shared library sections:\n",
627                         RETURN_MASK_ALL);
628
629           /* If requested, add the shared object's sections to the TARGET's
630              section table.  Do this immediately after mapping the object so
631              that later nodes in the list can query this object, as is needed
632              in solib-osf.c.  */
633           if (target)
634             {
635               int count = (i->sections_end - i->sections);
636               if (count > 0)
637                 {
638                   int space = target_resize_to_sections (target, count);
639                   memcpy (target->to_sections + space,
640                           i->sections,
641                           count * sizeof (i->sections[0]));
642                 }
643             }
644
645           /* Notify any observer that the shared object has been
646              loaded now that we've added it to GDB's tables.  */
647           observer_notify_solib_loaded (i);
648         }
649     }
650 }
651
652 /* Return non-zero if SO is the libpthread shared library.
653
654    Uses a fairly simplistic heuristic approach where we check
655    the file name against "/libpthread".  This can lead to false
656    positives, but this should be good enough in practice.  */
657
658 static int
659 libpthread_solib_p (struct so_list *so)
660 {
661   return (strstr (so->so_name, "/libpthread") != NULL);
662 }
663
664 /* GLOBAL FUNCTION
665
666    solib_add -- read in symbol info for newly added shared libraries
667
668    SYNOPSIS
669
670    void solib_add (char *pattern, int from_tty, struct target_ops
671    *TARGET, int readsyms)
672
673    DESCRIPTION
674
675    Read in symbolic information for any shared objects whose names
676    match PATTERN.  (If we've already read a shared object's symbol
677    info, leave it alone.)  If PATTERN is zero, read them all.
678
679    If READSYMS is 0, defer reading symbolic information until later
680    but still do any needed low level processing.
681
682    FROM_TTY and TARGET are as described for update_solib_list, above.  */
683
684 void
685 solib_add (char *pattern, int from_tty, struct target_ops *target, int readsyms)
686 {
687   struct so_list *gdb;
688
689   if (pattern)
690     {
691       char *re_err = re_comp (pattern);
692
693       if (re_err)
694         error (_("Invalid regexp: %s"), re_err);
695     }
696
697   update_solib_list (from_tty, target);
698
699   /* Walk the list of currently loaded shared libraries, and read
700      symbols for any that match the pattern --- or any whose symbols
701      aren't already loaded, if no pattern was given.  */
702   {
703     int any_matches = 0;
704     int loaded_any_symbols = 0;
705
706     for (gdb = so_list_head; gdb; gdb = gdb->next)
707       if (! pattern || re_exec (gdb->so_name))
708         {
709           /* Normally, we would read the symbols from that library
710              only if READSYMS is set.  However, we're making a small
711              exception for the pthread library, because we sometimes
712              need the library symbols to be loaded in order to provide
713              thread support (x86-linux for instance).  */
714           const int add_this_solib =
715             (readsyms || libpthread_solib_p (gdb));
716
717           any_matches = 1;
718           if (add_this_solib && solib_read_symbols (gdb, from_tty))
719             loaded_any_symbols = 1;
720         }
721
722     if (from_tty && pattern && ! any_matches)
723       printf_unfiltered
724         ("No loaded shared libraries match the pattern `%s'.\n", pattern);
725
726     if (loaded_any_symbols)
727       {
728         struct target_so_ops *ops = solib_ops (target_gdbarch);
729
730         /* Getting new symbols may change our opinion about what is
731            frameless.  */
732         reinit_frame_cache ();
733
734         ops->special_symbol_handling ();
735       }
736   }
737 }
738
739
740 /*
741
742    LOCAL FUNCTION
743
744    info_sharedlibrary_command -- code for "info sharedlibrary"
745
746    SYNOPSIS
747
748    static void info_sharedlibrary_command ()
749
750    DESCRIPTION
751
752    Walk through the shared library list and print information
753    about each attached library.
754  */
755
756 static void
757 info_sharedlibrary_command (char *ignore, int from_tty)
758 {
759   struct so_list *so = NULL;    /* link map state variable */
760   int header_done = 0;
761   int addr_width;
762
763   /* "0x", a little whitespace, and two hex digits per byte of pointers.  */
764   addr_width = 4 + (gdbarch_ptr_bit (target_gdbarch) / 4);
765
766   update_solib_list (from_tty, 0);
767
768   for (so = so_list_head; so; so = so->next)
769     {
770       if (so->so_name[0])
771         {
772           if (!header_done)
773             {
774               printf_unfiltered ("%-*s%-*s%-12s%s\n", addr_width, "From",
775                                  addr_width, "To", "Syms Read",
776                                  "Shared Object Library");
777               header_done++;
778             }
779
780           printf_unfiltered ("%-*s", addr_width,
781                              so->addr_high != 0
782                                ? hex_string_custom (
783                                    (LONGEST) so->addr_low,
784                                    addr_width - 4)
785                                : "");
786           printf_unfiltered ("%-*s", addr_width,
787                              so->addr_high != 0
788                                ? hex_string_custom (
789                                    (LONGEST) so->addr_high,
790                                    addr_width - 4)
791                                : "");
792           printf_unfiltered ("%-12s", so->symbols_loaded ? "Yes" : "No");
793           printf_unfiltered ("%s\n", so->so_name);
794         }
795     }
796   if (so_list_head == NULL)
797     {
798       printf_unfiltered (_("No shared libraries loaded at this time.\n"));
799     }
800 }
801
802 /*
803
804    GLOBAL FUNCTION
805
806    solib_address -- check to see if an address is in a shared lib
807
808    SYNOPSIS
809
810    char * solib_address (CORE_ADDR address)
811
812    DESCRIPTION
813
814    Provides a hook for other gdb routines to discover whether or
815    not a particular address is within the mapped address space of
816    a shared library.
817
818    For example, this routine is called at one point to disable
819    breakpoints which are in shared libraries that are not currently
820    mapped in.
821  */
822
823 char *
824 solib_address (CORE_ADDR address)
825 {
826   struct so_list *so = 0;       /* link map state variable */
827
828   for (so = so_list_head; so; so = so->next)
829     {
830       struct section_table *p;
831
832       for (p = so->sections; p < so->sections_end; p++)
833         {
834           if (p->addr <= address && address < p->endaddr)
835             return (so->so_name);
836         }
837     }
838
839   return (0);
840 }
841
842 /* Called by free_all_symtabs */
843
844 void
845 clear_solib (void)
846 {
847   struct target_so_ops *ops = solib_ops (target_gdbarch);
848
849   /* This function is expected to handle ELF shared libraries.  It is
850      also used on Solaris, which can run either ELF or a.out binaries
851      (for compatibility with SunOS 4), both of which can use shared
852      libraries.  So we don't know whether we have an ELF executable or
853      an a.out executable until the user chooses an executable file.
854
855      ELF shared libraries don't get mapped into the address space
856      until after the program starts, so we'd better not try to insert
857      breakpoints in them immediately.  We have to wait until the
858      dynamic linker has loaded them; we'll hit a bp_shlib_event
859      breakpoint (look for calls to create_solib_event_breakpoint) when
860      it's ready.
861
862      SunOS shared libraries seem to be different --- they're present
863      as soon as the process begins execution, so there's no need to
864      put off inserting breakpoints.  There's also nowhere to put a
865      bp_shlib_event breakpoint, so if we put it off, we'll never get
866      around to it.
867
868      So: disable breakpoints only if we're using ELF shared libs.  */
869   if (exec_bfd != NULL
870       && bfd_get_flavour (exec_bfd) != bfd_target_aout_flavour)
871     disable_breakpoints_in_shlibs ();
872
873   while (so_list_head)
874     {
875       struct so_list *so = so_list_head;
876       so_list_head = so->next;
877       if (so->abfd)
878         remove_target_sections (so->abfd);
879       free_so (so);
880     }
881
882   ops->clear_solib ();
883 }
884
885 /* GLOBAL FUNCTION
886
887    solib_create_inferior_hook -- shared library startup support
888
889    SYNOPSIS
890
891    void solib_create_inferior_hook ()
892
893    DESCRIPTION
894
895    When gdb starts up the inferior, it nurses it along (through the
896    shell) until it is ready to execute it's first instruction.  At this
897    point, this function gets called via expansion of the macro
898    SOLIB_CREATE_INFERIOR_HOOK.  */
899
900 void
901 solib_create_inferior_hook (void)
902 {
903   struct target_so_ops *ops = solib_ops (target_gdbarch);
904   ops->solib_create_inferior_hook();
905 }
906
907 /* GLOBAL FUNCTION
908
909    in_solib_dynsym_resolve_code -- check to see if an address is in
910                                    dynamic loader's dynamic symbol
911                                    resolution code
912
913    SYNOPSIS
914
915    int in_solib_dynsym_resolve_code (CORE_ADDR pc)
916
917    DESCRIPTION
918
919    Determine if PC is in the dynamic linker's symbol resolution
920    code.  Return 1 if so, 0 otherwise.
921 */
922
923 int
924 in_solib_dynsym_resolve_code (CORE_ADDR pc)
925 {
926   struct target_so_ops *ops = solib_ops (target_gdbarch);
927   return ops->in_dynsym_resolve_code (pc);
928 }
929
930 /*
931
932    LOCAL FUNCTION
933
934    sharedlibrary_command -- handle command to explicitly add library
935
936    SYNOPSIS
937
938    static void sharedlibrary_command (char *args, int from_tty)
939
940    DESCRIPTION
941
942  */
943
944 static void
945 sharedlibrary_command (char *args, int from_tty)
946 {
947   dont_repeat ();
948   solib_add (args, from_tty, (struct target_ops *) 0, 1);
949 }
950
951 /* LOCAL FUNCTION
952
953    no_shared_libraries -- handle command to explicitly discard symbols
954    from shared libraries.
955
956    DESCRIPTION
957
958    Implements the command "nosharedlibrary", which discards symbols
959    that have been auto-loaded from shared libraries.  Symbols from
960    shared libraries that were added by explicit request of the user
961    are not discarded.  Also called from remote.c.  */
962
963 void
964 no_shared_libraries (char *ignored, int from_tty)
965 {
966   objfile_purge_solibs ();
967   clear_solib ();
968 }
969
970 static void
971 reload_shared_libraries (char *ignored, int from_tty,
972                          struct cmd_list_element *e)
973 {
974   no_shared_libraries (NULL, from_tty);
975   solib_add (NULL, from_tty, NULL, auto_solib_add);
976 }
977
978 static void
979 show_auto_solib_add (struct ui_file *file, int from_tty,
980                      struct cmd_list_element *c, const char *value)
981 {
982   fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
983                     value);
984 }
985
986
987 /* Handler for library-specific lookup of global symbol NAME in OBJFILE.  Call
988    the library-specific handler if it is installed for the current target.  */
989
990 struct symbol *
991 solib_global_lookup (const struct objfile *objfile,
992                      const char *name,
993                      const char *linkage_name,
994                      const domain_enum domain)
995 {
996   struct target_so_ops *ops = solib_ops (target_gdbarch);
997
998   if (ops->lookup_lib_global_symbol != NULL)
999     return ops->lookup_lib_global_symbol (objfile, name, linkage_name, domain);
1000   return NULL;
1001 }
1002
1003
1004 extern initialize_file_ftype _initialize_solib; /* -Wmissing-prototypes */
1005
1006 void
1007 _initialize_solib (void)
1008 {
1009   struct cmd_list_element *c;
1010
1011   solib_data = gdbarch_data_register_pre_init (solib_init);
1012
1013   add_com ("sharedlibrary", class_files, sharedlibrary_command,
1014            _("Load shared object library symbols for files matching REGEXP."));
1015   add_info ("sharedlibrary", info_sharedlibrary_command,
1016             _("Status of loaded shared object libraries."));
1017   add_com ("nosharedlibrary", class_files, no_shared_libraries,
1018            _("Unload all shared object library symbols."));
1019
1020   add_setshow_boolean_cmd ("auto-solib-add", class_support,
1021                            &auto_solib_add, _("\
1022 Set autoloading of shared library symbols."), _("\
1023 Show autoloading of shared library symbols."), _("\
1024 If \"on\", symbols from all shared object libraries will be loaded\n\
1025 automatically when the inferior begins execution, when the dynamic linker\n\
1026 informs gdb that a new library has been loaded, or when attaching to the\n\
1027 inferior.  Otherwise, symbols must be loaded manually, using `sharedlibrary'."),
1028                            NULL,
1029                            show_auto_solib_add,
1030                            &setlist, &showlist);
1031
1032   add_setshow_filename_cmd ("sysroot", class_support,
1033                             &gdb_sysroot, _("\
1034 Set an alternate system root."), _("\
1035 Show the current system root."), _("\
1036 The system root is used to load absolute shared library symbol files.\n\
1037 For other (relative) files, you can add directories using\n\
1038 `set solib-search-path'."),
1039                             reload_shared_libraries,
1040                             NULL,
1041                             &setlist, &showlist);
1042
1043   add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1044                  &setlist);
1045   add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1046                  &showlist);
1047
1048   add_setshow_optional_filename_cmd ("solib-search-path", class_support,
1049                                      &solib_search_path, _("\
1050 Set the search path for loading non-absolute shared library symbol files."), _("\
1051 Show the search path for loading non-absolute shared library symbol files."), _("\
1052 This takes precedence over the environment variables PATH and LD_LIBRARY_PATH."),
1053                                      reload_shared_libraries,
1054                                      show_solib_search_path,
1055                                      &setlist, &showlist);
1056 }