Add _dl_load_lock, _dl_lazy, _dl_dynamic_weak, _dl_fpu_control,
[kopensolaris-gnu/glibc.git] / sysdeps / generic / ldsodefs.h
index ad4cbe6..3249105 100644 (file)
@@ -1,21 +1,21 @@
 /* Run-time dynamic linker data structures for loaded ELF shared objects.
-   Copyright (C) 1995-1999, 2000 Free Software Foundation, Inc.
+   Copyright (C) 1995-1999, 2000, 2001, 2002 Free Software Foundation, Inc.
    This file is part of the GNU C Library.
 
    The GNU C Library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Library General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
 
    The GNU C Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   Library General Public License for more details.
+   Lesser General Public License for more details.
 
-   You should have received a copy of the GNU Library General Public
-   License along with the GNU C Library; see the file COPYING.LIB.  If not,
-   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, write to the Free
+   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+   02111-1307 USA.  */
 
 #ifndef        _LDSODEFS_H
 #define        _LDSODEFS_H     1
 
 #include <elf.h>
 #include <dlfcn.h>
+#include <fpu_control.h>
+#include <sys/mman.h>
 #include <link.h>
 #include <dl-lookupcfg.h>
+#include <bits/libc-lock.h>
+#include <hp-timing.h>
 
 __BEGIN_DECLS
 
@@ -81,6 +85,33 @@ typedef ElfW(Addr) lookup_t;
           (map)->l_map_end - (map)->l_map_start)
 #endif
 
+/* By default we do not need special support to initialize DSOs loaded
+   by statically linked binaries.  */
+#ifndef DL_STATIC_INIT
+# define DL_STATIC_INIT(map)
+#endif
+
+/* Reloc type classes as returned by elf_machine_type_class().
+   ELF_RTYPE_CLASS_PLT means this reloc should not be satisfied by
+   some PLT symbol, ELF_RTYPE_CLASS_COPY means this reloc should not be
+   satisfied by any symbol in the executable.  */
+#define ELF_RTYPE_CLASS_PLT 1
+#define ELF_RTYPE_CLASS_COPY 2
+
+/* ELF uses the PF_x macros to specify the segment permissions, mmap
+   uses PROT_xxx.  In most cases the three macros have the values 1, 2,
+   and 3 but not in a matching order.  The following macros allows
+   converting from the PF_x values to PROT_xxx values.  */
+#define PF_TO_PROT \
+  ((PROT_READ << (PF_R * 4))                                                 \
+   | (PROT_WRITE << (PF_W * 4))                                                      \
+   | (PROT_EXEC << (PF_X * 4))                                               \
+   | ((PROT_READ | PROT_WRITE) << ((PF_R | PF_W) * 4))                       \
+   | ((PROT_READ | PROT_EXEC) << ((PF_R | PF_X) * 4))                        \
+   | ((PROT_WRITE | PROT_EXEC) << (PF_W | PF_X) * 4)                         \
+   | ((PROT_READ | PROT_WRITE | PROT_EXEC) << ((PF_R | PF_W | PF_X) * 4)))
+
+
 /* For the version handling we need an array with only names and their
    hash values.  */
 struct r_found_version
@@ -161,101 +192,202 @@ typedef void (*receiver_fct) (int, const char *, const char *);
    user interface to run-time dynamic linking.  */
 
 
-/* Parameters passed to the dynamic linker.  */
-extern char **_dl_argv;
+#ifndef SHARED
+# define EXTERN extern
+# define GL(name) _##name
+#else
+# define EXTERN
+# define GL(name) _rtld_global._##name
+struct rtld_global
+{
+#endif
+  /* Don't change the order of the following elements.  'dl_loaded'
+     must remain the first element.  Forever.  */
+
+  /* And a pointer to the map for the main map.  */
+  EXTERN struct link_map *_dl_loaded;
+  /* Number of object in the _dl_loaded list.  */
+  EXTERN unsigned int _dl_nloaded;
+  /* Array representing global scope.  */
+  EXTERN struct r_scope_elem *_dl_global_scope[2];
+  /* Direct pointer to the searchlist of the main object.  */
+  EXTERN struct r_scope_elem *_dl_main_searchlist;
+  /* Copy of the content of `_dl_main_searchlist'.  */
+  EXTERN struct r_scope_elem _dl_initial_searchlist;
+  /* This is zero at program start to signal that the global scope map is
+     allocated by rtld.  Later it keeps the size of the map.  It might be
+     reset if in _dl_close if the last global object is removed.  */
+  EXTERN size_t _dl_global_scope_alloc;
+
+  /* If nonzero the appropriate debug information is printed.  */
+  EXTERN int _dl_debug_mask;
+#define DL_DEBUG_LIBS      (1 << 0)
+#define DL_DEBUG_IMPCALLS   (1 << 1)
+#define DL_DEBUG_BINDINGS   (1 << 2)
+#define DL_DEBUG_SYMBOLS    (1 << 3)
+#define DL_DEBUG_VERSIONS   (1 << 4)
+#define DL_DEBUG_RELOC      (1 << 5)
+#define DL_DEBUG_FILES      (1 << 6)
+#define DL_DEBUG_STATISTICS (1 << 7)
+/* This one is used only internally.  */
+#define DL_DEBUG_HELP       (1 << 8)
+#define DL_DEBUG_PRELINK    (1 << 9)
+
+  /* Cached value of `getpagesize ()'.  */
+  EXTERN size_t _dl_pagesize;
+
+  /* During the program run we must not modify the global data of
+     loaded shared object simultanously in two threads.  Therefore we
+     protect `_dl_open' and `_dl_close' in dl-close.c.
+
+     This must be a recursive lock since the initializer function of
+     the loaded object might as well require a call to this function.
+     At this time it is not anymore a problem to modify the tables.  */
+  __libc_lock_define_recursive (EXTERN, _dl_load_lock)
+
+  /* OS version.  */
+  EXTERN unsigned int _dl_osversion;
+  /* Platform name.  */
+  EXTERN const char *_dl_platform;
+  EXTERN size_t _dl_platformlen;
+
+#ifndef MAP_ANON
+  /* File descriptor referring to the zero-fill device.  */
+  EXTERN int _dl_zerofd;
+#endif
+
+  /* CLK_TCK as reported by the kernel.  */
+  EXTERN int _dl_clktck;
 
-/* Cached value of `getpagesize ()'.  */
-extern size_t _dl_pagesize;
+  /* If nonzero print warnings messages.  */
+  EXTERN int _dl_verbose;
 
-/* File descriptor referring to the zero-fill device.  */
-extern int _dl_zerofd;
+  /* Do we do lazy relocations?  */
+  EXTERN int _dl_lazy;
 
-/* Name of the shared object to be profiled (if any).  */
-extern const char *_dl_profile;
-/* Map of shared object to be profiled.  */
-extern struct link_map *_dl_profile_map;
-/* Filename of the output file.  */
-extern const char *_dl_profile_output;
+  /* Nonzero if runtime lookups should not update the .got/.plt.  */
+  EXTERN int _dl_bind_not;
 
-/* If nonzero the appropriate debug information is printed.  */
-extern int _dl_debug_libs;
-extern int _dl_debug_impcalls;
-extern int _dl_debug_bindings;
-extern int _dl_debug_symbols;
-extern int _dl_debug_versions;
-extern int _dl_debug_reloc;
-extern int _dl_debug_files;
+  /* Nonzero if references should be treated as weak during runtime
+     linking.  */
+  EXTERN int _dl_dynamic_weak;
 
-/* Expect cache ID.  */
-extern int _dl_correct_cache_id;
+  /* Default floating-point control word.  */
+  EXTERN fpu_control_t _dl_fpu_control;
 
-/* Mask for hardware capabilities that are available.  */
-extern unsigned long int _dl_hwcap;
+  /* The object to be initialized first.  */
+  EXTERN struct link_map *_dl_initfirst;
 
-/* Mask for important hardware capabilities we honour. */
-extern unsigned long int _dl_hwcap_mask;
+  /* Start time on CPU clock.  */
+#if HP_TIMING_AVAIL
+  EXTERN hp_timing_t _dl_cpuclock_offset;
+#endif
 
-/* File descriptor to write debug messages to.  */
-extern int _dl_debug_fd;
+  /* Name of the shared object to be profiled (if any).  */
+  EXTERN const char *_dl_profile;
+  /* Map of shared object to be profiled.  */
+  EXTERN struct link_map *_dl_profile_map;
+  /* Filename of the output file.  */
+  EXTERN const char *_dl_profile_output;
+  /* Map of shared object to be prelink traced.  */
+  EXTERN struct link_map *_dl_trace_prelink_map;
+  /* Name of the object we want to trace the prelinking.  */
+  EXTERN const char *_dl_trace_prelink;
 
-/* Names of shared object for which the RPATH should be ignored.  */
-extern const char *_dl_inhibit_rpath;
+  /* Expected cache ID.  */
+  EXTERN int _dl_correct_cache_id;
 
-/* Nonzero if references should be treated as weak during runtime linking.  */
-extern int _dl_dynamic_weak;
+  /* Counters for the number of relocations performed.  */
+  EXTERN unsigned long int _dl_num_relocations;
+  EXTERN unsigned long int _dl_num_cache_relocations;
+
+  /* Mask for hardware capabilities that are available.  */
+  EXTERN unsigned long int _dl_hwcap;
+
+  /* Mask for important hardware capabilities we honour. */
+  EXTERN unsigned long int _dl_hwcap_mask;
+
+  /* Names of shared object for which the RPATH should be ignored.  */
+  EXTERN const char *_dl_inhibit_rpath;
+
+  /* Location of the binary.  */
+  EXTERN const char *_dl_origin_path;
+
+  /* List of search directories.  */
+  EXTERN struct r_search_path_elem *_dl_all_dirs;
+  EXTERN struct r_search_path_elem *_dl_init_all_dirs;
+
+  /* File descriptor to write debug messages to.  */
+  EXTERN int _dl_debug_fd;
+
+  /* Structure describing the dynamic linker itself.  */
+  EXTERN struct link_map _dl_rtld_map;
+#ifdef SHARED
+};
+extern struct rtld_global _rtld_global;
+#endif
+#undef EXTERN
+
+/* Parameters passed to the dynamic linker.  */
+extern int _dl_argc;
+extern char **_dl_argv;
 
 /* The array with message we print as a last resort.  */
 extern const char _dl_out_of_memory[];
 
-/* Nonzero if runtime lookups should not update the .got/.plt.  */
-extern int _dl_bind_not;
-
-/* List of search directories.  */
-extern struct r_search_path_elem *_dl_all_dirs;
-extern struct r_search_path_elem *_dl_init_all_dirs;
 
 /* OS-dependent function to open the zero-fill device.  */
 extern int _dl_sysdep_open_zero_fill (void); /* dl-sysdep.c */
 
-/* OS-dependent function to write a message on the specified
-   descriptor FD.  All arguments are `const char *'; args until a null
-   pointer are concatenated to form the message to print.  */
-extern void _dl_sysdep_output (int fd, const char *string, ...);
-
-/* OS-dependent function to write a debug message on the specified
-   descriptor for this.  All arguments are `const char *'; args until
-   a null pointer are concatenated to form the message to print.  If
-   NEW_LINE is nonzero it is assumed that the message starts on a new
-   line.  */
-extern void _dl_debug_message (int new_line, const char *string, ...);
-
-/* OS-dependent function to write a message on the standard output.
-   All arguments are `const char *'; args until a null pointer
-   are concatenated to form the message to print.  */
-#define _dl_sysdep_message(string, args...) \
-  _dl_sysdep_output (STDOUT_FILENO, string, ##args)
-
-/* OS-dependent function to write a message on the standard error.
-   All arguments are `const char *'; args until a null pointer
-   are concatenated to form the message to print.  */
-#define _dl_sysdep_error(string, args...) \
-  _dl_sysdep_output (STDERR_FILENO, string, ##args)
-
-/* OS-dependent function to give a fatal error message and exit
-   when the dynamic linker fails before the program is fully linked.
-   All arguments are `const char *'; args until a null pointer
-   are concatenated to form the message to print.  */
-#define _dl_sysdep_fatal(string, args...) \
+
+/* During the program run we must not modify the global data of
+   loaded shared object simultanously in two threads.  Therefore we
+   protect `_dl_open' and `_dl_close' in dl-close.c.
+
+   This must be a recursive lock since the initializer function of
+   the loaded object might as well require a call to this function.
+   At this time it is not anymore a problem to modify the tables.  */
+__libc_lock_define_recursive (extern, _dl_load_lock)
+
+
+/* Write message on the debug file descriptor.  The parameters are
+   interpreted as for a `printf' call.  All the lines start with a
+   tag showing the PID.  */
+extern void _dl_debug_printf (const char *fmt, ...)
+     __attribute__ ((__format__ (__printf__, 1, 2)));
+
+/* Write message on the debug file descriptor.  The parameters are
+   interpreted as for a `printf' call.  All the lines buf the first
+   start with a tag showing the PID.  */
+extern void _dl_debug_printf_c (const char *fmt, ...)
+     __attribute__ ((__format__ (__printf__, 1, 2)));
+
+
+/* Write a message on the specified descriptor FD.  The parameters are
+   interpreted as for a `printf' call.  */
+extern void _dl_dprintf (int fd, const char *fmt, ...)
+     __attribute__ ((__format__ (__printf__, 2, 3)));
+
+/* Write a message on the specified descriptor standard output.  The
+   parameters are interpreted as for a `printf' call.  */
+#define _dl_printf(fmt, args...) \
+  _dl_dprintf (STDOUT_FILENO, fmt, ##args)
+
+/* Write a message on the specified descriptor standard error.  The
+   parameters are interpreted as for a `printf' call.  */
+#define _dl_error_printf(fmt, args...) \
+  _dl_dprintf (STDERR_FILENO, fmt, ##args)
+
+/* Write a message on the specified descriptor standard error and exit
+   the program.  The parameters are interpreted as for a `printf' call.  */
+#define _dl_fatal_printf(fmt, args...) \
   do                                                                         \
     {                                                                        \
-      _dl_sysdep_output (STDERR_FILENO, string, ##args);                     \
+      _dl_dprintf (STDERR_FILENO, fmt, ##args);                                      \
       _exit (127);                                                           \
     }                                                                        \
   while (1)
 
-/* Nonzero if the program should be "secure" (i.e. it's setuid or somesuch).
-   This tells the dynamic linker to ignore environment variables.  */
-extern int _dl_secure;
 
 /* This function is called by all the internal dynamic linker functions
    when they encounter an error.  ERRCODE is either an `errno' code or
@@ -263,15 +395,14 @@ extern int _dl_secure;
    it is a general problem; ERRSTRING is a string describing the specific
    problem.  */
 extern void _dl_signal_error (int errcode, const char *object,
-                             const char *errstring)
+                             const char *occurred, const char *errstring)
      internal_function
      __attribute__ ((__noreturn__));
 
 /* Like _dl_signal_error, but may return when called in the context of
    _dl_receive_error.  */
-extern void _dl_signal_cerror (int errcode,
-                              const char *object,
-                              const char *errstring)
+extern void _dl_signal_cerror (int errcode, const char *object,
+                              const char *occation, const char *errstring)
      internal_function;
 
 /* Call OPERATE, receiving errors from `dl_signal_cerror'.  Unlike
@@ -314,14 +445,12 @@ extern void _dl_setup_hash (struct link_map *map) internal_function;
    l_searchlist (i.e. the segment of the dependency tree starting at that
    object) is searched in turn.  REFERENCE_NAME should name the object
    containing the reference; it is used in error messages.
-   RELOC_TYPE is a machine-dependent reloc type, which is passed to
-   the `elf_machine_lookup_*_p' macros in dl-machine.h to affect which
-   symbols can be chosen.  */
+   TYPE_CLASS describes the type of symbol we are looking for.  */
 extern lookup_t _dl_lookup_symbol (const char *undef,
                                   struct link_map *undef_map,
                                   const ElfW(Sym) **sym,
                                   struct r_scope_elem *symbol_scope[],
-                                  int reloc_type, int explicit)
+                                  int type_class, int explicit)
      internal_function;
 
 /* Lookup versioned symbol.  */
@@ -330,7 +459,7 @@ extern lookup_t _dl_lookup_versioned_symbol (const char *undef,
                                             const ElfW(Sym) **sym,
                                             struct r_scope_elem *symbol_scope[],
                                             const struct r_found_version *version,
-                                            int reloc_type, int explicit)
+                                            int type_class, int explicit)
      internal_function;
 
 /* For handling RTLD_NEXT we must be able to skip shared objects.  */
@@ -355,24 +484,6 @@ extern lookup_t _dl_lookup_versioned_symbol_skip (const char *undef,
 extern ElfW(Addr) _dl_symbol_value (struct link_map *map, const char *name)
      internal_function;
 
-
-/* Structure describing the dynamic linker itself.  */
-extern struct link_map _dl_rtld_map;
-/* And a pointer to the map for the main map.  */
-extern struct link_map *_dl_loaded;
-/* Number of object in the _dl_loaded list.  */
-extern unsigned int _dl_nloaded;
-/* Array representing global scope.  */
-extern struct r_scope_elem *_dl_global_scope[2];
-/* Direct pointer to the searchlist of the main object.  */
-extern struct r_scope_elem *_dl_main_searchlist;
-/* Copy of the content of `_dl_main_searchlist'.  */
-extern struct r_scope_elem _dl_initial_searchlist;
-/* This is zero at program start to signal that the global scope map is
-   allocated by rtld.  Later it keeps the size of the map.  It might be
-   reset if in _dl_close if the last global object is removed.  */
-extern size_t _dl_global_scope_alloc;
-
 /* Allocate a `struct link_map' for a new object being loaded,
    and enter it into the _dl_main_map list.  */
 extern struct link_map *_dl_new_object (char *realname, const char *libname,
@@ -390,8 +501,13 @@ extern void _dl_relocate_object (struct link_map *map,
    TYPE is the result of ELFW(R_TYPE) (r_info), i.e. an R_<CPU>_* value.
    PLT is nonzero if this was a PLT reloc; it just affects the message.  */
 extern void _dl_reloc_bad_type (struct link_map *map,
-                               uint_fast8_t type, int plt)
-     internal_function;
+                               unsigned int type, int plt)
+     internal_function __attribute__ ((__noreturn__));
+
+/* Resolve conflicts if prelinking.  */
+extern void _dl_resolve_conflicts (struct link_map *l,
+                                  ElfW(Rela) *conflict,
+                                  ElfW(Rela) *conflictend);
 
 /* Check the version dependencies of all objects available through
    MAP.  If VERBOSE print some more diagnostics.  */
@@ -456,6 +572,37 @@ extern const struct r_strlenpair *_dl_important_hwcaps (const char *platform,
                                                        size_t *max_capstrlen)
      internal_function;
 
+/* Look up NAME in ld.so.cache and return the file name stored there,
+   or null if none is found.  */
+extern const char *_dl_load_cache_lookup (const char *name)
+     internal_function;
+
+/* If the system does not support MAP_COPY we cannot leave the file open
+   all the time since this would create problems when the file is replaced.
+   Therefore we provide this function to close the file and open it again
+   once needed.  */
+extern void _dl_unload_cache (void);
+
+/* System-dependent function to read a file's whole contents in the
+   most convenient manner available.  *SIZEP gets the size of the
+   file.  On error MAP_FAILED is returned.  */
+extern void *_dl_sysdep_read_whole_file (const char *file, size_t *sizep,
+                                        int prot)
+     internal_function;
+
+/* System-specific function to do initial startup for the dynamic linker.
+   After this, file access calls and getenv must work.  This is responsible
+   for setting __libc_enable_secure if we need to be secure (e.g. setuid),
+   and for setting _dl_argc and _dl_argv, and then calling _dl_main.  */
+extern ElfW(Addr) _dl_sysdep_start (void **start_argptr,
+                                   void (*dl_main) (const ElfW(Phdr) *phdr,
+                                                    ElfW(Word) phnum,
+                                                    ElfW(Addr) *user_entry));
+
+extern void _dl_sysdep_start_cleanup (void)
+     internal_function;
+
+
 __END_DECLS
 
 #endif /* ldsodefs.h */