Update Copyright year range in all files maintained by GDB.
[external/binutils.git] / gdb / solib.c
1 /* Handle shared libraries for GDB, the GNU Debugger.
2
3    Copyright (C) 1990-2014 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 #include "defs.h"
21
22 #include <sys/types.h>
23 #include <fcntl.h>
24 #include <string.h>
25 #include "symtab.h"
26 #include "bfd.h"
27 #include "symfile.h"
28 #include "objfiles.h"
29 #include "exceptions.h"
30 #include "gdbcore.h"
31 #include "command.h"
32 #include "target.h"
33 #include "frame.h"
34 #include "gdb_regex.h"
35 #include "inferior.h"
36 #include "environ.h"
37 #include "language.h"
38 #include "gdbcmd.h"
39 #include "completer.h"
40 #include "filenames.h"          /* for DOSish file names */
41 #include "exec.h"
42 #include "solist.h"
43 #include "observer.h"
44 #include "readline/readline.h"
45 #include "remote.h"
46 #include "solib.h"
47 #include "interps.h"
48 #include "filesystem.h"
49 #include "gdb_bfd.h"
50 #include "filestuff.h"
51
52 /* Architecture-specific operations.  */
53
54 /* Per-architecture data key.  */
55 static struct gdbarch_data *solib_data;
56
57 static void *
58 solib_init (struct obstack *obstack)
59 {
60   struct target_so_ops **ops;
61
62   ops = OBSTACK_ZALLOC (obstack, struct target_so_ops *);
63   *ops = current_target_so_ops;
64   return ops;
65 }
66
67 static const struct target_so_ops *
68 solib_ops (struct gdbarch *gdbarch)
69 {
70   const struct target_so_ops **ops = gdbarch_data (gdbarch, solib_data);
71
72   return *ops;
73 }
74
75 /* Set the solib operations for GDBARCH to NEW_OPS.  */
76
77 void
78 set_solib_ops (struct gdbarch *gdbarch, const struct target_so_ops *new_ops)
79 {
80   const struct target_so_ops **ops = gdbarch_data (gdbarch, solib_data);
81
82   *ops = new_ops;
83 }
84 \f
85
86 /* external data declarations */
87
88 /* FIXME: gdbarch needs to control this variable, or else every
89    configuration needs to call set_solib_ops.  */
90 struct target_so_ops *current_target_so_ops;
91
92 /* List of known shared objects */
93 #define so_list_head current_program_space->so_list
94
95 /* Local function prototypes */
96
97 /* If non-empty, this is a search path for loading non-absolute shared library
98    symbol files.  This takes precedence over the environment variables PATH
99    and LD_LIBRARY_PATH.  */
100 static char *solib_search_path = NULL;
101 static void
102 show_solib_search_path (struct ui_file *file, int from_tty,
103                         struct cmd_list_element *c, const char *value)
104 {
105   fprintf_filtered (file, _("The search path for loading non-absolute "
106                             "shared library symbol files is %s.\n"),
107                     value);
108 }
109
110 /* Same as HAVE_DOS_BASED_FILE_SYSTEM, but useable as an rvalue.  */
111 #if (HAVE_DOS_BASED_FILE_SYSTEM)
112 #  define DOS_BASED_FILE_SYSTEM 1
113 #else
114 #  define DOS_BASED_FILE_SYSTEM 0
115 #endif
116
117 /* Returns the full pathname of the shared library file, or NULL if
118    not found.  (The pathname is malloc'ed; it needs to be freed by the
119    caller.)  *FD is set to either -1 or an open file handle for the
120    library.
121
122    Global variable GDB_SYSROOT is used as a prefix directory
123    to search for shared libraries if they have an absolute path.
124
125    Global variable SOLIB_SEARCH_PATH is used as a prefix directory
126    (or set of directories, as in LD_LIBRARY_PATH) to search for all
127    shared libraries if not found in GDB_SYSROOT.
128
129    Search algorithm:
130    * If there is a gdb_sysroot and path is absolute:
131    *   Search for gdb_sysroot/path.
132    * else
133    *   Look for it literally (unmodified).
134    * Look in SOLIB_SEARCH_PATH.
135    * If available, use target defined search function.
136    * If gdb_sysroot is NOT set, perform the following two searches:
137    *   Look in inferior's $PATH.
138    *   Look in inferior's $LD_LIBRARY_PATH.
139    *
140    * The last check avoids doing this search when targetting remote
141    * machines since gdb_sysroot will almost always be set.
142 */
143
144 char *
145 solib_find (char *in_pathname, int *fd)
146 {
147   const struct target_so_ops *ops = solib_ops (target_gdbarch ());
148   int found_file = -1;
149   char *temp_pathname = NULL;
150   int gdb_sysroot_is_empty;
151   const char *solib_symbols_extension
152     = gdbarch_solib_symbols_extension (target_gdbarch ());
153   const char *fskind = effective_target_file_system_kind ();
154   struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
155   char *sysroot = NULL;
156
157   /* If solib_symbols_extension is set, replace the file's
158      extension.  */
159   if (solib_symbols_extension)
160     {
161       char *p = in_pathname + strlen (in_pathname);
162
163       while (p > in_pathname && *p != '.')
164         p--;
165
166       if (*p == '.')
167         {
168           char *new_pathname;
169
170           new_pathname = alloca (p - in_pathname + 1
171                                  + strlen (solib_symbols_extension) + 1);
172           memcpy (new_pathname, in_pathname, p - in_pathname + 1);
173           strcpy (new_pathname + (p - in_pathname) + 1,
174                   solib_symbols_extension);
175
176           in_pathname = new_pathname;
177         }
178     }
179
180   gdb_sysroot_is_empty = (gdb_sysroot == NULL || *gdb_sysroot == 0);
181
182   if (!gdb_sysroot_is_empty)
183     {
184       int prefix_len = strlen (gdb_sysroot);
185
186       /* Remove trailing slashes from absolute prefix.  */
187       while (prefix_len > 0
188              && IS_DIR_SEPARATOR (gdb_sysroot[prefix_len - 1]))
189         prefix_len--;
190
191       sysroot = savestring (gdb_sysroot, prefix_len);
192       make_cleanup (xfree, sysroot);
193     }
194
195   /* If we're on a non-DOS-based system, backslashes won't be
196      understood as directory separator, so, convert them to forward
197      slashes, iff we're supposed to handle DOS-based file system
198      semantics for target paths.  */
199   if (!DOS_BASED_FILE_SYSTEM && fskind == file_system_kind_dos_based)
200     {
201       char *p;
202
203       /* Avoid clobbering our input.  */
204       p = alloca (strlen (in_pathname) + 1);
205       strcpy (p, in_pathname);
206       in_pathname = p;
207
208       for (; *p; p++)
209         {
210           if (*p == '\\')
211             *p = '/';
212         }
213     }
214
215   /* Note, we're interested in IS_TARGET_ABSOLUTE_PATH, not
216      IS_ABSOLUTE_PATH.  The latter is for host paths only, while
217      IN_PATHNAME is a target path.  For example, if we're supposed to
218      be handling DOS-like semantics we want to consider a
219      'c:/foo/bar.dll' path as an absolute path, even on a Unix box.
220      With such a path, before giving up on the sysroot, we'll try:
221
222        1st attempt, c:/foo/bar.dll ==> /sysroot/c:/foo/bar.dll
223        2nd attempt, c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll
224        3rd attempt, c:/foo/bar.dll ==> /sysroot/foo/bar.dll
225   */
226
227   if (!IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname) || gdb_sysroot_is_empty)
228     temp_pathname = xstrdup (in_pathname);
229   else
230     {
231       int need_dir_separator;
232
233       /* Concatenate the sysroot and the target reported filename.  We
234          may need to glue them with a directory separator.  Cases to
235          consider:
236
237         | sysroot         | separator | in_pathname    |
238         |-----------------+-----------+----------------|
239         | /some/dir       | /         | c:/foo/bar.dll |
240         | /some/dir       |           | /foo/bar.dll   |
241         | remote:         |           | c:/foo/bar.dll |
242         | remote:         |           | /foo/bar.dll   |
243         | remote:some/dir | /         | c:/foo/bar.dll |
244         | remote:some/dir |           | /foo/bar.dll   |
245
246         IOW, we don't need to add a separator if IN_PATHNAME already
247         has one, or when the the sysroot is exactly "remote:".
248         There's no need to check for drive spec explicitly, as we only
249         get here if IN_PATHNAME is considered an absolute path.  */
250       need_dir_separator = !(IS_DIR_SEPARATOR (in_pathname[0])
251                              || strcmp (REMOTE_SYSROOT_PREFIX, sysroot) == 0);
252
253       /* Cat the prefixed pathname together.  */
254       temp_pathname = concat (sysroot,
255                               need_dir_separator ? SLASH_STRING : "",
256                               in_pathname, (char *) NULL);
257     }
258
259   /* Handle remote files.  */
260   if (remote_filename_p (temp_pathname))
261     {
262       *fd = -1;
263       do_cleanups (old_chain);
264       return temp_pathname;
265     }
266
267   /* Now see if we can open it.  */
268   found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
269   if (found_file < 0)
270     xfree (temp_pathname);
271
272   /* If the search in gdb_sysroot failed, and the path name has a
273      drive spec (e.g, c:/foo), try stripping ':' from the drive spec,
274      and retrying in the sysroot:
275        c:/foo/bar.dll ==> /sysroot/c/foo/bar.dll.  */
276
277   if (found_file < 0
278       && !gdb_sysroot_is_empty
279       && HAS_TARGET_DRIVE_SPEC (fskind, in_pathname))
280     {
281       int need_dir_separator = !IS_DIR_SEPARATOR (in_pathname[2]);
282       char *drive = savestring (in_pathname, 1);
283
284       temp_pathname = concat (sysroot,
285                               SLASH_STRING,
286                               drive,
287                               need_dir_separator ? SLASH_STRING : "",
288                               in_pathname + 2, (char *) NULL);
289       xfree (drive);
290
291       found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
292       if (found_file < 0)
293         {
294           xfree (temp_pathname);
295
296           /* If the search in gdb_sysroot still failed, try fully
297              stripping the drive spec, and trying once more in the
298              sysroot before giving up.
299
300              c:/foo/bar.dll ==> /sysroot/foo/bar.dll.  */
301
302           temp_pathname = concat (sysroot,
303                                   need_dir_separator ? SLASH_STRING : "",
304                                   in_pathname + 2, (char *) NULL);
305
306           found_file = gdb_open_cloexec (temp_pathname, O_RDONLY | O_BINARY, 0);
307           if (found_file < 0)
308             xfree (temp_pathname);
309         }
310     }
311
312   do_cleanups (old_chain);
313
314   /* We try to find the library in various ways.  After each attempt,
315      either found_file >= 0 and temp_pathname is a malloc'd string, or
316      found_file < 0 and temp_pathname does not point to storage that
317      needs to be freed.  */
318
319   if (found_file < 0)
320     temp_pathname = NULL;
321
322   /* If the search in gdb_sysroot failed, and the path name is
323      absolute at this point, make it relative.  (openp will try and open the
324      file according to its absolute path otherwise, which is not what we want.)
325      Affects subsequent searches for this solib.  */
326   if (found_file < 0 && IS_TARGET_ABSOLUTE_PATH (fskind, in_pathname))
327     {
328       /* First, get rid of any drive letters etc.  */
329       while (!IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
330         in_pathname++;
331
332       /* Next, get rid of all leading dir separators.  */
333       while (IS_TARGET_DIR_SEPARATOR (fskind, *in_pathname))
334         in_pathname++;
335     }
336
337   /* If not found, search the solib_search_path (if any).  */
338   if (found_file < 0 && solib_search_path != NULL)
339     found_file = openp (solib_search_path,
340                         OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
341                         in_pathname, O_RDONLY | O_BINARY, &temp_pathname);
342
343   /* If not found, next search the solib_search_path (if any) for the basename
344      only (ignoring the path).  This is to allow reading solibs from a path
345      that differs from the opened path.  */
346   if (found_file < 0 && solib_search_path != NULL)
347     found_file = openp (solib_search_path,
348                         OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
349                         target_lbasename (fskind, in_pathname),
350                         O_RDONLY | O_BINARY, &temp_pathname);
351
352   /* If not found, try to use target supplied solib search method.  */
353   if (found_file < 0 && ops->find_and_open_solib)
354     found_file = ops->find_and_open_solib (in_pathname, O_RDONLY | O_BINARY,
355                                            &temp_pathname);
356
357   /* If not found, next search the inferior's $PATH environment variable.  */
358   if (found_file < 0 && gdb_sysroot_is_empty)
359     found_file = openp (get_in_environ (current_inferior ()->environment,
360                                         "PATH"),
361                         OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
362                         O_RDONLY | O_BINARY, &temp_pathname);
363
364   /* If not found, next search the inferior's $LD_LIBRARY_PATH
365      environment variable.  */
366   if (found_file < 0 && gdb_sysroot_is_empty)
367     found_file = openp (get_in_environ (current_inferior ()->environment,
368                                         "LD_LIBRARY_PATH"),
369                         OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH, in_pathname,
370                         O_RDONLY | O_BINARY, &temp_pathname);
371
372   *fd = found_file;
373   return temp_pathname;
374 }
375
376 /* Open and return a BFD for the shared library PATHNAME.  If FD is not -1,
377    it is used as file handle to open the file.  Throws an error if the file
378    could not be opened.  Handles both local and remote file access.
379
380    PATHNAME must be malloc'ed by the caller.  It will be freed by this
381    function.  If unsuccessful, the FD will be closed (unless FD was
382    -1).  */
383
384 bfd *
385 solib_bfd_fopen (char *pathname, int fd)
386 {
387   bfd *abfd;
388
389   if (remote_filename_p (pathname))
390     {
391       gdb_assert (fd == -1);
392       abfd = remote_bfd_open (pathname, gnutarget);
393     }
394   else
395     {
396       abfd = gdb_bfd_open (pathname, gnutarget, fd);
397
398       if (abfd)
399         bfd_set_cacheable (abfd, 1);
400     }
401
402   if (!abfd)
403     {
404       make_cleanup (xfree, pathname);
405       error (_("Could not open `%s' as an executable file: %s"),
406              pathname, bfd_errmsg (bfd_get_error ()));
407     }
408
409   xfree (pathname);
410
411   return abfd;
412 }
413
414 /* Find shared library PATHNAME and open a BFD for it.  */
415
416 bfd *
417 solib_bfd_open (char *pathname)
418 {
419   char *found_pathname;
420   int found_file;
421   bfd *abfd;
422   const struct bfd_arch_info *b;
423
424   /* Search for shared library file.  */
425   found_pathname = solib_find (pathname, &found_file);
426   if (found_pathname == NULL)
427     {
428       /* Return failure if the file could not be found, so that we can
429          accumulate messages about missing libraries.  */
430       if (errno == ENOENT)
431         return NULL;
432
433       perror_with_name (pathname);
434     }
435
436   /* Open bfd for shared library.  */
437   abfd = solib_bfd_fopen (found_pathname, found_file);
438
439   /* Check bfd format.  */
440   if (!bfd_check_format (abfd, bfd_object))
441     {
442       make_cleanup_bfd_unref (abfd);
443       error (_("`%s': not in executable format: %s"),
444              bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
445     }
446
447   /* Check bfd arch.  */
448   b = gdbarch_bfd_arch_info (target_gdbarch ());
449   if (!b->compatible (b, bfd_get_arch_info (abfd)))
450     warning (_("`%s': Shared library architecture %s is not compatible "
451                "with target architecture %s."), bfd_get_filename (abfd),
452              bfd_get_arch_info (abfd)->printable_name, b->printable_name);
453
454   return abfd;
455 }
456
457 /* Given a pointer to one of the shared objects in our list of mapped
458    objects, use the recorded name to open a bfd descriptor for the
459    object, build a section table, relocate all the section addresses
460    by the base address at which the shared object was mapped, and then
461    add the sections to the target's section table.
462
463    FIXME: In most (all?) cases the shared object file name recorded in
464    the dynamic linkage tables will be a fully qualified pathname.  For
465    cases where it isn't, do we really mimic the systems search
466    mechanism correctly in the below code (particularly the tilde
467    expansion stuff?).  */
468
469 static int
470 solib_map_sections (struct so_list *so)
471 {
472   const struct target_so_ops *ops = solib_ops (target_gdbarch ());
473   char *filename;
474   struct target_section *p;
475   struct cleanup *old_chain;
476   bfd *abfd;
477
478   filename = tilde_expand (so->so_name);
479   old_chain = make_cleanup (xfree, filename);
480   abfd = ops->bfd_open (filename);
481   do_cleanups (old_chain);
482
483   if (abfd == NULL)
484     return 0;
485
486   /* Leave bfd open, core_xfer_memory and "info files" need it.  */
487   so->abfd = abfd;
488
489   /* Copy the full path name into so_name, allowing symbol_file_add
490      to find it later.  This also affects the =library-loaded GDB/MI
491      event, and in particular the part of that notification providing
492      the library's host-side path.  If we let the target dictate
493      that objfile's path, and the target is different from the host,
494      GDB/MI will not provide the correct host-side path.  */
495   if (strlen (bfd_get_filename (abfd)) >= SO_NAME_MAX_PATH_SIZE)
496     error (_("Shared library file name is too long."));
497   strcpy (so->so_name, bfd_get_filename (abfd));
498
499   if (build_section_table (abfd, &so->sections, &so->sections_end))
500     {
501       error (_("Can't find the file sections in `%s': %s"),
502              bfd_get_filename (abfd), bfd_errmsg (bfd_get_error ()));
503     }
504
505   for (p = so->sections; p < so->sections_end; p++)
506     {
507       /* Relocate the section binding addresses as recorded in the shared
508          object's file by the base address to which the object was actually
509          mapped.  */
510       ops->relocate_section_addresses (so, p);
511
512       /* If the target didn't provide information about the address
513          range of the shared object, assume we want the location of
514          the .text section.  */
515       if (so->addr_low == 0 && so->addr_high == 0
516           && strcmp (p->the_bfd_section->name, ".text") == 0)
517         {
518           so->addr_low = p->addr;
519           so->addr_high = p->endaddr;
520         }
521     }
522
523   /* Add the shared object's sections to the current set of file
524      section tables.  Do this immediately after mapping the object so
525      that later nodes in the list can query this object, as is needed
526      in solib-osf.c.  */
527   add_target_sections (so, so->sections, so->sections_end);
528
529   return 1;
530 }
531
532 /* Free symbol-file related contents of SO and reset for possible reloading
533    of SO.  If we have opened a BFD for SO, close it.  If we have placed SO's
534    sections in some target's section table, the caller is responsible for
535    removing them.
536
537    This function doesn't mess with objfiles at all.  If there is an
538    objfile associated with SO that needs to be removed, the caller is
539    responsible for taking care of that.  */
540
541 static void
542 clear_so (struct so_list *so)
543 {
544   const struct target_so_ops *ops = solib_ops (target_gdbarch ());
545
546   if (so->sections)
547     {
548       xfree (so->sections);
549       so->sections = so->sections_end = NULL;
550     }
551
552   gdb_bfd_unref (so->abfd);
553   so->abfd = NULL;
554
555   /* Our caller closed the objfile, possibly via objfile_purge_solibs.  */
556   so->symbols_loaded = 0;
557   so->objfile = NULL;
558
559   so->addr_low = so->addr_high = 0;
560
561   /* Restore the target-supplied file name.  SO_NAME may be the path
562      of the symbol file.  */
563   strcpy (so->so_name, so->so_original_name);
564
565   /* Do the same for target-specific data.  */
566   if (ops->clear_so != NULL)
567     ops->clear_so (so);
568 }
569
570 /* Free the storage associated with the `struct so_list' object SO.
571    If we have opened a BFD for SO, close it.
572
573    The caller is responsible for removing SO from whatever list it is
574    a member of.  If we have placed SO's sections in some target's
575    section table, the caller is responsible for removing them.
576
577    This function doesn't mess with objfiles at all.  If there is an
578    objfile associated with SO that needs to be removed, the caller is
579    responsible for taking care of that.  */
580
581 void
582 free_so (struct so_list *so)
583 {
584   const struct target_so_ops *ops = solib_ops (target_gdbarch ());
585
586   clear_so (so);
587   ops->free_so (so);
588
589   xfree (so);
590 }
591
592
593 /* Return address of first so_list entry in master shared object list.  */
594 struct so_list *
595 master_so_list (void)
596 {
597   return so_list_head;
598 }
599
600 /* Read in symbols for shared object SO.  If SYMFILE_VERBOSE is set in FLAGS,
601    be chatty about it.  Return non-zero if any symbols were actually
602    loaded.  */
603
604 int
605 solib_read_symbols (struct so_list *so, int flags)
606 {
607   const int from_tty = flags & SYMFILE_VERBOSE;
608
609   if (so->symbols_loaded)
610     {
611       /* If needed, we've already warned in our caller.  */
612     }
613   else if (so->abfd == NULL)
614     {
615       /* We've already warned about this library, when trying to open
616          it.  */
617     }
618   else
619     {
620       volatile struct gdb_exception e;
621
622       flags |= current_inferior ()->symfile_flags;
623
624       TRY_CATCH (e, RETURN_MASK_ERROR)
625         {
626           struct section_addr_info *sap;
627
628           /* Have we already loaded this shared object?  */
629           ALL_OBJFILES (so->objfile)
630             {
631               if (filename_cmp (objfile_name (so->objfile), so->so_name) == 0
632                   && so->objfile->addr_low == so->addr_low)
633                 break;
634             }
635           if (so->objfile != NULL)
636             break;
637
638           sap = build_section_addr_info_from_section_table (so->sections,
639                                                             so->sections_end);
640           so->objfile = symbol_file_add_from_bfd (so->abfd, so->so_name,
641                                                   flags, sap, OBJF_SHARED,
642                                                   NULL);
643           so->objfile->addr_low = so->addr_low;
644           free_section_addr_info (sap);
645         }
646
647       if (e.reason < 0)
648         exception_fprintf (gdb_stderr, e, _("Error while reading shared"
649                                             " library symbols for %s:\n"),
650                            so->so_name);
651       else
652         {
653           if (from_tty || info_verbose)
654             printf_unfiltered (_("Loaded symbols for %s\n"), so->so_name);
655           so->symbols_loaded = 1;
656         }
657       return 1;
658     }
659
660   return 0;
661 }
662
663 /* Return 1 if KNOWN->objfile is used by any other so_list object in the
664    SO_LIST_HEAD list.  Return 0 otherwise.  */
665
666 static int
667 solib_used (const struct so_list *const known)
668 {
669   const struct so_list *pivot;
670
671   for (pivot = so_list_head; pivot != NULL; pivot = pivot->next)
672     if (pivot != known && pivot->objfile == known->objfile)
673       return 1;
674   return 0;
675 }
676
677 /* Synchronize GDB's shared object list with inferior's.
678
679    Extract the list of currently loaded shared objects from the
680    inferior, and compare it with the list of shared objects currently
681    in GDB's so_list_head list.  Edit so_list_head to bring it in sync
682    with the inferior's new list.
683
684    If we notice that the inferior has unloaded some shared objects,
685    free any symbolic info GDB had read about those shared objects.
686
687    Don't load symbolic info for any new shared objects; just add them
688    to the list, and leave their symbols_loaded flag clear.
689
690    If FROM_TTY is non-null, feel free to print messages about what
691    we're doing.
692
693    If TARGET is non-null, add the sections of all new shared objects
694    to TARGET's section table.  Note that this doesn't remove any
695    sections for shared objects that have been unloaded, and it
696    doesn't check to see if the new shared objects are already present in
697    the section table.  But we only use this for core files and
698    processes we've just attached to, so that's okay.  */
699
700 static void
701 update_solib_list (int from_tty, struct target_ops *target)
702 {
703   const struct target_so_ops *ops = solib_ops (target_gdbarch ());
704   struct so_list *inferior = ops->current_sos();
705   struct so_list *gdb, **gdb_link;
706
707   /* We can reach here due to changing solib-search-path or the
708      sysroot, before having any inferior.  */
709   if (target_has_execution && !ptid_equal (inferior_ptid, null_ptid))
710     {
711       struct inferior *inf = current_inferior ();
712
713       /* If we are attaching to a running process for which we
714          have not opened a symbol file, we may be able to get its
715          symbols now!  */
716       if (inf->attach_flag && symfile_objfile == NULL)
717         catch_errors (ops->open_symbol_file_object, &from_tty,
718                       "Error reading attached process's symbol file.\n",
719                       RETURN_MASK_ALL);
720     }
721
722   /* GDB and the inferior's dynamic linker each maintain their own
723      list of currently loaded shared objects; we want to bring the
724      former in sync with the latter.  Scan both lists, seeing which
725      shared objects appear where.  There are three cases:
726
727      - A shared object appears on both lists.  This means that GDB
728      knows about it already, and it's still loaded in the inferior.
729      Nothing needs to happen.
730
731      - A shared object appears only on GDB's list.  This means that
732      the inferior has unloaded it.  We should remove the shared
733      object from GDB's tables.
734
735      - A shared object appears only on the inferior's list.  This
736      means that it's just been loaded.  We should add it to GDB's
737      tables.
738
739      So we walk GDB's list, checking each entry to see if it appears
740      in the inferior's list too.  If it does, no action is needed, and
741      we remove it from the inferior's list.  If it doesn't, the
742      inferior has unloaded it, and we remove it from GDB's list.  By
743      the time we're done walking GDB's list, the inferior's list
744      contains only the new shared objects, which we then add.  */
745
746   gdb = so_list_head;
747   gdb_link = &so_list_head;
748   while (gdb)
749     {
750       struct so_list *i = inferior;
751       struct so_list **i_link = &inferior;
752
753       /* Check to see whether the shared object *gdb also appears in
754          the inferior's current list.  */
755       while (i)
756         {
757           if (ops->same)
758             {
759               if (ops->same (gdb, i))
760                 break;
761             }
762           else
763             {
764               if (! filename_cmp (gdb->so_original_name, i->so_original_name))
765                 break;        
766             }
767
768           i_link = &i->next;
769           i = *i_link;
770         }
771
772       /* If the shared object appears on the inferior's list too, then
773          it's still loaded, so we don't need to do anything.  Delete
774          it from the inferior's list, and leave it on GDB's list.  */
775       if (i)
776         {
777           *i_link = i->next;
778           free_so (i);
779           gdb_link = &gdb->next;
780           gdb = *gdb_link;
781         }
782
783       /* If it's not on the inferior's list, remove it from GDB's tables.  */
784       else
785         {
786           /* Notify any observer that the shared object has been
787              unloaded before we remove it from GDB's tables.  */
788           observer_notify_solib_unloaded (gdb);
789
790           VEC_safe_push (char_ptr, current_program_space->deleted_solibs,
791                          xstrdup (gdb->so_name));
792
793           *gdb_link = gdb->next;
794
795           /* Unless the user loaded it explicitly, free SO's objfile.  */
796           if (gdb->objfile && ! (gdb->objfile->flags & OBJF_USERLOADED)
797               && !solib_used (gdb))
798             free_objfile (gdb->objfile);
799
800           /* Some targets' section tables might be referring to
801              sections from so->abfd; remove them.  */
802           remove_target_sections (gdb);
803
804           free_so (gdb);
805           gdb = *gdb_link;
806         }
807     }
808
809   /* Now the inferior's list contains only shared objects that don't
810      appear in GDB's list --- those that are newly loaded.  Add them
811      to GDB's shared object list.  */
812   if (inferior)
813     {
814       int not_found = 0;
815       const char *not_found_filename = NULL;
816
817       struct so_list *i;
818
819       /* Add the new shared objects to GDB's list.  */
820       *gdb_link = inferior;
821
822       /* Fill in the rest of each of the `struct so_list' nodes.  */
823       for (i = inferior; i; i = i->next)
824         {
825           volatile struct gdb_exception e;
826
827           i->pspace = current_program_space;
828           VEC_safe_push (so_list_ptr, current_program_space->added_solibs, i);
829
830           TRY_CATCH (e, RETURN_MASK_ERROR)
831             {
832               /* Fill in the rest of the `struct so_list' node.  */
833               if (!solib_map_sections (i))
834                 {
835                   not_found++;
836                   if (not_found_filename == NULL)
837                     not_found_filename = i->so_original_name;
838                 }
839             }
840
841           if (e.reason < 0)
842             exception_fprintf (gdb_stderr, e,
843                                _("Error while mapping shared "
844                                  "library sections:\n"));
845
846           /* Notify any observer that the shared object has been
847              loaded now that we've added it to GDB's tables.  */
848           observer_notify_solib_loaded (i);
849         }
850
851       /* If a library was not found, issue an appropriate warning
852          message.  We have to use a single call to warning in case the
853          front end does something special with warnings, e.g., pop up
854          a dialog box.  It Would Be Nice if we could get a "warning: "
855          prefix on each line in the CLI front end, though - it doesn't
856          stand out well.  */
857
858       if (not_found == 1)
859         warning (_("Could not load shared library symbols for %s.\n"
860                    "Do you need \"set solib-search-path\" "
861                    "or \"set sysroot\"?"),
862                  not_found_filename);
863       else if (not_found > 1)
864         warning (_("\
865 Could not load shared library symbols for %d libraries, e.g. %s.\n\
866 Use the \"info sharedlibrary\" command to see the complete listing.\n\
867 Do you need \"set solib-search-path\" or \"set sysroot\"?"),
868                  not_found, not_found_filename);
869     }
870 }
871
872
873 /* Return non-zero if NAME is the libpthread shared library.
874
875    Uses a fairly simplistic heuristic approach where we check
876    the file name against "/libpthread".  This can lead to false
877    positives, but this should be good enough in practice.  */
878
879 int
880 libpthread_name_p (const char *name)
881 {
882   return (strstr (name, "/libpthread") != NULL);
883 }
884
885 /* Return non-zero if SO is the libpthread shared library.  */
886
887 static int
888 libpthread_solib_p (struct so_list *so)
889 {
890   return libpthread_name_p (so->so_name);
891 }
892
893 /* Read in symbolic information for any shared objects whose names
894    match PATTERN.  (If we've already read a shared object's symbol
895    info, leave it alone.)  If PATTERN is zero, read them all.
896
897    If READSYMS is 0, defer reading symbolic information until later
898    but still do any needed low level processing.
899
900    FROM_TTY and TARGET are as described for update_solib_list, above.  */
901
902 void
903 solib_add (char *pattern, int from_tty,
904            struct target_ops *target, int readsyms)
905 {
906   struct so_list *gdb;
907
908   current_program_space->solib_add_generation++;
909
910   if (pattern)
911     {
912       char *re_err = re_comp (pattern);
913
914       if (re_err)
915         error (_("Invalid regexp: %s"), re_err);
916     }
917
918   update_solib_list (from_tty, target);
919
920   /* Walk the list of currently loaded shared libraries, and read
921      symbols for any that match the pattern --- or any whose symbols
922      aren't already loaded, if no pattern was given.  */
923   {
924     int any_matches = 0;
925     int loaded_any_symbols = 0;
926     const int flags =
927         SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
928
929     for (gdb = so_list_head; gdb; gdb = gdb->next)
930       if (! pattern || re_exec (gdb->so_name))
931         {
932           /* Normally, we would read the symbols from that library
933              only if READSYMS is set.  However, we're making a small
934              exception for the pthread library, because we sometimes
935              need the library symbols to be loaded in order to provide
936              thread support (x86-linux for instance).  */
937           const int add_this_solib =
938             (readsyms || libpthread_solib_p (gdb));
939
940           any_matches = 1;
941           if (add_this_solib)
942             {
943               if (gdb->symbols_loaded)
944                 {
945                   /* If no pattern was given, be quiet for shared
946                      libraries we have already loaded.  */
947                   if (pattern && (from_tty || info_verbose))
948                     printf_unfiltered (_("Symbols already loaded for %s\n"),
949                                        gdb->so_name);
950                 }
951               else if (solib_read_symbols (gdb, flags))
952                 loaded_any_symbols = 1;
953             }
954         }
955
956     if (loaded_any_symbols)
957       breakpoint_re_set ();
958
959     if (from_tty && pattern && ! any_matches)
960       printf_unfiltered
961         ("No loaded shared libraries match the pattern `%s'.\n", pattern);
962
963     if (loaded_any_symbols)
964       {
965         const struct target_so_ops *ops = solib_ops (target_gdbarch ());
966
967         /* Getting new symbols may change our opinion about what is
968            frameless.  */
969         reinit_frame_cache ();
970
971         ops->special_symbol_handling ();
972       }
973   }
974 }
975
976 /* Implement the "info sharedlibrary" command.  Walk through the
977    shared library list and print information about each attached
978    library matching PATTERN.  If PATTERN is elided, print them
979    all.  */
980
981 static void
982 info_sharedlibrary_command (char *pattern, int from_tty)
983 {
984   struct so_list *so = NULL;    /* link map state variable */
985   int so_missing_debug_info = 0;
986   int addr_width;
987   int nr_libs;
988   struct cleanup *table_cleanup;
989   struct gdbarch *gdbarch = target_gdbarch ();
990   struct ui_out *uiout = current_uiout;
991
992   if (pattern)
993     {
994       char *re_err = re_comp (pattern);
995
996       if (re_err)
997         error (_("Invalid regexp: %s"), re_err);
998     }
999
1000   /* "0x", a little whitespace, and two hex digits per byte of pointers.  */
1001   addr_width = 4 + (gdbarch_ptr_bit (gdbarch) / 4);
1002
1003   update_solib_list (from_tty, 0);
1004
1005   /* make_cleanup_ui_out_table_begin_end needs to know the number of
1006      rows, so we need to make two passes over the libs.  */
1007
1008   for (nr_libs = 0, so = so_list_head; so; so = so->next)
1009     {
1010       if (so->so_name[0])
1011         {
1012           if (pattern && ! re_exec (so->so_name))
1013             continue;
1014           ++nr_libs;
1015         }
1016     }
1017
1018   table_cleanup =
1019     make_cleanup_ui_out_table_begin_end (uiout, 4, nr_libs,
1020                                          "SharedLibraryTable");
1021
1022   /* The "- 1" is because ui_out adds one space between columns.  */
1023   ui_out_table_header (uiout, addr_width - 1, ui_left, "from", "From");
1024   ui_out_table_header (uiout, addr_width - 1, ui_left, "to", "To");
1025   ui_out_table_header (uiout, 12 - 1, ui_left, "syms-read", "Syms Read");
1026   ui_out_table_header (uiout, 0, ui_noalign,
1027                        "name", "Shared Object Library");
1028
1029   ui_out_table_body (uiout);
1030
1031   for (so = so_list_head; so; so = so->next)
1032     {
1033       struct cleanup *lib_cleanup;
1034
1035       if (! so->so_name[0])
1036         continue;
1037       if (pattern && ! re_exec (so->so_name))
1038         continue;
1039
1040       lib_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "lib");
1041
1042       if (so->addr_high != 0)
1043         {
1044           ui_out_field_core_addr (uiout, "from", gdbarch, so->addr_low);
1045           ui_out_field_core_addr (uiout, "to", gdbarch, so->addr_high);
1046         }
1047       else
1048         {
1049           ui_out_field_skip (uiout, "from");
1050           ui_out_field_skip (uiout, "to");
1051         }
1052
1053       if (! ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ()))
1054           && so->symbols_loaded
1055           && !objfile_has_symbols (so->objfile))
1056         {
1057           so_missing_debug_info = 1;
1058           ui_out_field_string (uiout, "syms-read", "Yes (*)");
1059         }
1060       else
1061         ui_out_field_string (uiout, "syms-read", 
1062                              so->symbols_loaded ? "Yes" : "No");
1063
1064       ui_out_field_string (uiout, "name", so->so_name);
1065
1066       ui_out_text (uiout, "\n");
1067
1068       do_cleanups (lib_cleanup);
1069     }
1070
1071   do_cleanups (table_cleanup);
1072
1073   if (nr_libs == 0)
1074     {
1075       if (pattern)
1076         ui_out_message (uiout, 0,
1077                         _("No shared libraries matched.\n"));
1078       else
1079         ui_out_message (uiout, 0,
1080                         _("No shared libraries loaded at this time.\n"));
1081     }
1082   else
1083     {
1084       if (so_missing_debug_info)
1085         ui_out_message (uiout, 0,
1086                         _("(*): Shared library is missing "
1087                           "debugging information.\n"));
1088     }
1089 }
1090
1091 /* Return 1 if ADDRESS lies within SOLIB.  */
1092
1093 int
1094 solib_contains_address_p (const struct so_list *const solib,
1095                           CORE_ADDR address)
1096 {
1097   struct target_section *p;
1098
1099   for (p = solib->sections; p < solib->sections_end; p++)
1100     if (p->addr <= address && address < p->endaddr)
1101       return 1;
1102
1103   return 0;
1104 }
1105
1106 /* If ADDRESS is in a shared lib in program space PSPACE, return its
1107    name.
1108
1109    Provides a hook for other gdb routines to discover whether or not a
1110    particular address is within the mapped address space of a shared
1111    library.
1112
1113    For example, this routine is called at one point to disable
1114    breakpoints which are in shared libraries that are not currently
1115    mapped in.  */
1116
1117 char *
1118 solib_name_from_address (struct program_space *pspace, CORE_ADDR address)
1119 {
1120   struct so_list *so = NULL;
1121
1122   for (so = pspace->so_list; so; so = so->next)
1123     if (solib_contains_address_p (so, address))
1124       return (so->so_name);
1125
1126   return (0);
1127 }
1128
1129 /* Return whether the data starting at VADDR, size SIZE, must be kept
1130    in a core file for shared libraries loaded before "gcore" is used
1131    to be handled correctly when the core file is loaded.  This only
1132    applies when the section would otherwise not be kept in the core
1133    file (in particular, for readonly sections).  */
1134
1135 int
1136 solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size)
1137 {
1138   const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1139
1140   if (ops->keep_data_in_core)
1141     return ops->keep_data_in_core (vaddr, size);
1142   else
1143     return 0;
1144 }
1145
1146 /* Called by free_all_symtabs */
1147
1148 void
1149 clear_solib (void)
1150 {
1151   const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1152
1153   /* This function is expected to handle ELF shared libraries.  It is
1154      also used on Solaris, which can run either ELF or a.out binaries
1155      (for compatibility with SunOS 4), both of which can use shared
1156      libraries.  So we don't know whether we have an ELF executable or
1157      an a.out executable until the user chooses an executable file.
1158
1159      ELF shared libraries don't get mapped into the address space
1160      until after the program starts, so we'd better not try to insert
1161      breakpoints in them immediately.  We have to wait until the
1162      dynamic linker has loaded them; we'll hit a bp_shlib_event
1163      breakpoint (look for calls to create_solib_event_breakpoint) when
1164      it's ready.
1165
1166      SunOS shared libraries seem to be different --- they're present
1167      as soon as the process begins execution, so there's no need to
1168      put off inserting breakpoints.  There's also nowhere to put a
1169      bp_shlib_event breakpoint, so if we put it off, we'll never get
1170      around to it.
1171
1172      So: disable breakpoints only if we're using ELF shared libs.  */
1173   if (exec_bfd != NULL
1174       && bfd_get_flavour (exec_bfd) != bfd_target_aout_flavour)
1175     disable_breakpoints_in_shlibs ();
1176
1177   while (so_list_head)
1178     {
1179       struct so_list *so = so_list_head;
1180
1181       so_list_head = so->next;
1182       observer_notify_solib_unloaded (so);
1183       remove_target_sections (so);
1184       free_so (so);
1185     }
1186
1187   ops->clear_solib ();
1188 }
1189
1190 /* Shared library startup support.  When GDB starts up the inferior,
1191    it nurses it along (through the shell) until it is ready to execute
1192    its first instruction.  At this point, this function gets
1193    called.  */
1194
1195 void
1196 solib_create_inferior_hook (int from_tty)
1197 {
1198   const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1199
1200   ops->solib_create_inferior_hook (from_tty);
1201 }
1202
1203 /* Check to see if an address is in the dynamic loader's dynamic
1204    symbol resolution code.  Return 1 if so, 0 otherwise.  */
1205
1206 int
1207 in_solib_dynsym_resolve_code (CORE_ADDR pc)
1208 {
1209   const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1210
1211   return ops->in_dynsym_resolve_code (pc);
1212 }
1213
1214 /* Implements the "sharedlibrary" command.  */
1215
1216 static void
1217 sharedlibrary_command (char *args, int from_tty)
1218 {
1219   dont_repeat ();
1220   solib_add (args, from_tty, (struct target_ops *) 0, 1);
1221 }
1222
1223 /* Implements the command "nosharedlibrary", which discards symbols
1224    that have been auto-loaded from shared libraries.  Symbols from
1225    shared libraries that were added by explicit request of the user
1226    are not discarded.  Also called from remote.c.  */
1227
1228 void
1229 no_shared_libraries (char *ignored, int from_tty)
1230 {
1231   /* The order of the two routines below is important: clear_solib notifies
1232      the solib_unloaded observers, and some of these observers might need
1233      access to their associated objfiles.  Therefore, we can not purge the
1234      solibs' objfiles before clear_solib has been called.  */
1235
1236   clear_solib ();
1237   objfile_purge_solibs ();
1238 }
1239
1240 /* See solib.h.  */
1241
1242 void
1243 update_solib_breakpoints (void)
1244 {
1245   const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1246
1247   if (ops->update_breakpoints != NULL)
1248     ops->update_breakpoints ();
1249 }
1250
1251 /* See solib.h.  */
1252
1253 void
1254 handle_solib_event (void)
1255 {
1256   const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1257
1258   if (ops->handle_event != NULL)
1259     ops->handle_event ();
1260
1261   clear_program_space_solib_cache (current_inferior ()->pspace);
1262
1263   /* Check for any newly added shared libraries if we're supposed to
1264      be adding them automatically.  Switch terminal for any messages
1265      produced by breakpoint_re_set.  */
1266   target_terminal_ours_for_output ();
1267   solib_add (NULL, 0, &current_target, auto_solib_add);
1268   target_terminal_inferior ();
1269 }
1270
1271 /* Reload shared libraries, but avoid reloading the same symbol file
1272    we already have loaded.  */
1273
1274 static void
1275 reload_shared_libraries_1 (int from_tty)
1276 {
1277   struct so_list *so;
1278   struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1279
1280   for (so = so_list_head; so != NULL; so = so->next)
1281     {
1282       char *filename, *found_pathname = NULL;
1283       bfd *abfd;
1284       int was_loaded = so->symbols_loaded;
1285       const int flags =
1286         SYMFILE_DEFER_BP_RESET | (from_tty ? SYMFILE_VERBOSE : 0);
1287
1288       filename = tilde_expand (so->so_original_name);
1289       make_cleanup (xfree, filename);
1290       abfd = solib_bfd_open (filename);
1291       if (abfd != NULL)
1292         {
1293           found_pathname = xstrdup (bfd_get_filename (abfd));
1294           make_cleanup (xfree, found_pathname);
1295           gdb_bfd_unref (abfd);
1296         }
1297
1298       /* If this shared library is no longer associated with its previous
1299          symbol file, close that.  */
1300       if ((found_pathname == NULL && was_loaded)
1301           || (found_pathname != NULL
1302               && filename_cmp (found_pathname, so->so_name) != 0))
1303         {
1304           if (so->objfile && ! (so->objfile->flags & OBJF_USERLOADED)
1305               && !solib_used (so))
1306             free_objfile (so->objfile);
1307           remove_target_sections (so);
1308           clear_so (so);
1309         }
1310
1311       /* If this shared library is now associated with a new symbol
1312          file, open it.  */
1313       if (found_pathname != NULL
1314           && (!was_loaded
1315               || filename_cmp (found_pathname, so->so_name) != 0))
1316         {
1317           volatile struct gdb_exception e;
1318
1319           TRY_CATCH (e, RETURN_MASK_ERROR)
1320             solib_map_sections (so);
1321
1322           if (e.reason < 0)
1323             exception_fprintf (gdb_stderr, e,
1324                                _("Error while mapping "
1325                                  "shared library sections:\n"));
1326           else if (auto_solib_add || was_loaded || libpthread_solib_p (so))
1327             solib_read_symbols (so, flags);
1328         }
1329     }
1330
1331   do_cleanups (old_chain);
1332 }
1333
1334 static void
1335 reload_shared_libraries (char *ignored, int from_tty,
1336                          struct cmd_list_element *e)
1337 {
1338   const struct target_so_ops *ops;
1339
1340   reload_shared_libraries_1 (from_tty);
1341
1342   ops = solib_ops (target_gdbarch ());
1343
1344   /* Creating inferior hooks here has two purposes.  First, if we reload 
1345      shared libraries then the address of solib breakpoint we've computed
1346      previously might be no longer valid.  For example, if we forgot to set
1347      solib-absolute-prefix and are setting it right now, then the previous
1348      breakpoint address is plain wrong.  Second, installing solib hooks
1349      also implicitly figures were ld.so is and loads symbols for it.
1350      Absent this call, if we've just connected to a target and set 
1351      solib-absolute-prefix or solib-search-path, we'll lose all information
1352      about ld.so.  */
1353   if (target_has_execution)
1354     {
1355       /* Reset or free private data structures not associated with
1356          so_list entries.  */
1357       ops->clear_solib ();
1358
1359       /* Remove any previous solib event breakpoint.  This is usually
1360          done in common code, at breakpoint_init_inferior time, but
1361          we're not really starting up the inferior here.  */
1362       remove_solib_event_breakpoints ();
1363
1364       solib_create_inferior_hook (from_tty);
1365     }
1366
1367   /* Sometimes the platform-specific hook loads initial shared
1368      libraries, and sometimes it doesn't.  If it doesn't FROM_TTY will be
1369      incorrectly 0 but such solib targets should be fixed anyway.  If we
1370      made all the inferior hook methods consistent, this call could be
1371      removed.  Call it only after the solib target has been initialized by
1372      solib_create_inferior_hook.  */
1373
1374   solib_add (NULL, 0, NULL, auto_solib_add);
1375
1376   breakpoint_re_set ();
1377
1378   /* We may have loaded or unloaded debug info for some (or all)
1379      shared libraries.  However, frames may still reference them.  For
1380      example, a frame's unwinder might still point at DWARF FDE
1381      structures that are now freed.  Also, getting new symbols may
1382      change our opinion about what is frameless.  */
1383   reinit_frame_cache ();
1384
1385   ops->special_symbol_handling ();
1386 }
1387
1388 static void
1389 show_auto_solib_add (struct ui_file *file, int from_tty,
1390                      struct cmd_list_element *c, const char *value)
1391 {
1392   fprintf_filtered (file, _("Autoloading of shared library symbols is %s.\n"),
1393                     value);
1394 }
1395
1396
1397 /* Handler for library-specific lookup of global symbol NAME in OBJFILE.  Call
1398    the library-specific handler if it is installed for the current target.  */
1399
1400 struct symbol *
1401 solib_global_lookup (const struct objfile *objfile,
1402                      const char *name,
1403                      const domain_enum domain)
1404 {
1405   const struct target_so_ops *ops = solib_ops (target_gdbarch ());
1406
1407   if (ops->lookup_lib_global_symbol != NULL)
1408     return ops->lookup_lib_global_symbol (objfile, name, domain);
1409   return NULL;
1410 }
1411
1412 /* Lookup the value for a specific symbol from dynamic symbol table.  Look
1413    up symbol from ABFD.  MATCH_SYM is a callback function to determine
1414    whether to pick up a symbol.  DATA is the input of this callback
1415    function.  Return NULL if symbol is not found.  */
1416
1417 CORE_ADDR
1418 gdb_bfd_lookup_symbol_from_symtab (bfd *abfd,
1419                                    int (*match_sym) (asymbol *, void *),
1420                                    void *data)
1421 {
1422   long storage_needed = bfd_get_symtab_upper_bound (abfd);
1423   CORE_ADDR symaddr = 0;
1424
1425   if (storage_needed > 0)
1426     {
1427       unsigned int i;
1428
1429       asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1430       struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1431       unsigned int number_of_symbols =
1432         bfd_canonicalize_symtab (abfd, symbol_table);
1433
1434       for (i = 0; i < number_of_symbols; i++)
1435         {
1436           asymbol *sym  = *symbol_table++;
1437
1438           if (match_sym (sym, data))
1439             {
1440               /* BFD symbols are section relative.  */
1441               symaddr = sym->value + sym->section->vma;
1442               break;
1443             }
1444         }
1445       do_cleanups (back_to);
1446     }
1447
1448   return symaddr;
1449 }
1450
1451 /* Lookup the value for a specific symbol from symbol table.  Look up symbol
1452    from ABFD.  MATCH_SYM is a callback function to determine whether to pick
1453    up a symbol.  DATA is the input of this callback function.  Return NULL
1454    if symbol is not found.  */
1455
1456 static CORE_ADDR
1457 bfd_lookup_symbol_from_dyn_symtab (bfd *abfd,
1458                                    int (*match_sym) (asymbol *, void *),
1459                                    void *data)
1460 {
1461   long storage_needed = bfd_get_dynamic_symtab_upper_bound (abfd);
1462   CORE_ADDR symaddr = 0;
1463
1464   if (storage_needed > 0)
1465     {
1466       unsigned int i;
1467       asymbol **symbol_table = (asymbol **) xmalloc (storage_needed);
1468       struct cleanup *back_to = make_cleanup (xfree, symbol_table);
1469       unsigned int number_of_symbols =
1470         bfd_canonicalize_dynamic_symtab (abfd, symbol_table);
1471
1472       for (i = 0; i < number_of_symbols; i++)
1473         {
1474           asymbol *sym = *symbol_table++;
1475
1476           if (match_sym (sym, data))
1477             {
1478               /* BFD symbols are section relative.  */
1479               symaddr = sym->value + sym->section->vma;
1480               break;
1481             }
1482         }
1483       do_cleanups (back_to);
1484     }
1485   return symaddr;
1486 }
1487
1488 /* Lookup the value for a specific symbol from symbol table and dynamic
1489    symbol table.  Look up symbol from ABFD.  MATCH_SYM is a callback
1490    function to determine whether to pick up a symbol.  DATA is the
1491    input of this callback function.  Return NULL if symbol is not
1492    found.  */
1493
1494 CORE_ADDR
1495 gdb_bfd_lookup_symbol (bfd *abfd,
1496                        int (*match_sym) (asymbol *, void *),
1497                        void *data)
1498 {
1499   CORE_ADDR symaddr = gdb_bfd_lookup_symbol_from_symtab (abfd, match_sym, data);
1500
1501   /* On FreeBSD, the dynamic linker is stripped by default.  So we'll
1502      have to check the dynamic string table too.  */
1503   if (symaddr == 0)
1504     symaddr = bfd_lookup_symbol_from_dyn_symtab (abfd, match_sym, data);
1505
1506   return symaddr;
1507 }
1508
1509 /* SO_LIST_HEAD may contain user-loaded object files that can be removed
1510    out-of-band by the user.  So upon notification of free_objfile remove
1511    all references to any user-loaded file that is about to be freed.  */
1512
1513 static void
1514 remove_user_added_objfile (struct objfile *objfile)
1515 {
1516   struct so_list *so;
1517
1518   if (objfile != 0 && objfile->flags & OBJF_USERLOADED)
1519     {
1520       for (so = so_list_head; so != NULL; so = so->next)
1521         if (so->objfile == objfile)
1522           so->objfile = NULL;
1523     }
1524 }
1525
1526 extern initialize_file_ftype _initialize_solib; /* -Wmissing-prototypes */
1527
1528 void
1529 _initialize_solib (void)
1530 {
1531   solib_data = gdbarch_data_register_pre_init (solib_init);
1532
1533   observer_attach_free_objfile (remove_user_added_objfile);
1534
1535   add_com ("sharedlibrary", class_files, sharedlibrary_command,
1536            _("Load shared object library symbols for files matching REGEXP."));
1537   add_info ("sharedlibrary", info_sharedlibrary_command,
1538             _("Status of loaded shared object libraries."));
1539   add_com ("nosharedlibrary", class_files, no_shared_libraries,
1540            _("Unload all shared object library symbols."));
1541
1542   add_setshow_boolean_cmd ("auto-solib-add", class_support,
1543                            &auto_solib_add, _("\
1544 Set autoloading of shared library symbols."), _("\
1545 Show autoloading of shared library symbols."), _("\
1546 If \"on\", symbols from all shared object libraries will be loaded\n\
1547 automatically when the inferior begins execution, when the dynamic linker\n\
1548 informs gdb that a new library has been loaded, or when attaching to the\n\
1549 inferior.  Otherwise, symbols must be loaded manually, using \
1550 `sharedlibrary'."),
1551                            NULL,
1552                            show_auto_solib_add,
1553                            &setlist, &showlist);
1554
1555   add_setshow_filename_cmd ("sysroot", class_support,
1556                             &gdb_sysroot, _("\
1557 Set an alternate system root."), _("\
1558 Show the current system root."), _("\
1559 The system root is used to load absolute shared library symbol files.\n\
1560 For other (relative) files, you can add directories using\n\
1561 `set solib-search-path'."),
1562                             reload_shared_libraries,
1563                             NULL,
1564                             &setlist, &showlist);
1565
1566   add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1567                  &setlist);
1568   add_alias_cmd ("solib-absolute-prefix", "sysroot", class_support, 0,
1569                  &showlist);
1570
1571   add_setshow_optional_filename_cmd ("solib-search-path", class_support,
1572                                      &solib_search_path, _("\
1573 Set the search path for loading non-absolute shared library symbol files."),
1574                                      _("\
1575 Show the search path for loading non-absolute shared library symbol files."),
1576                                      _("\
1577 This takes precedence over the environment variables \
1578 PATH and LD_LIBRARY_PATH."),
1579                                      reload_shared_libraries,
1580                                      show_solib_search_path,
1581                                      &setlist, &showlist);
1582 }