Implemented runtime dynamic linker to support ELF shared libraries.
[kopensolaris-gnu/glibc.git] / elf / link.h
1 /* Run-time dynamic linker data structures for loaded ELF shared objects.
2 Copyright (C) 1995 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 License, or (at your option) any later version.
9
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with the GNU C Library; see the file COPYING.LIB.  If
17 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
18 Cambridge, MA 02139, USA.  */
19
20 #ifndef _LINK_H
21 #define _LINK_H 1
22
23 #include <elf.h>
24
25
26 /* Rendezvous structure used by the run-time dynamic linker to communicate
27    details of shared object loading to the debugger.  If the executable's
28    dynamic section has a DT_DEBUG element, the run-time linker sets that
29    element's value to the address where this structure can be found.  */
30
31 struct r_debug
32   {
33     int r_version;              /* Version number for this protocol.  */
34
35     struct link_map *r_map;     /* Head of the chain of loaded objects.  */
36
37     /* This is the address of a function internal to the run-time linker,
38        that will always be called when the linker begins to map in a
39        library or unmap it, and again when the mapping change is complete.
40        The debugger can set a breakpoint at this address if it wants to
41        notice shared object mapping changes.  */
42     Elf32_Addr r_brk;
43     enum
44       {
45         /* This state value describes the mapping change taking place when
46            the `r_brk' address is called.  */
47         RT_CONSISTENT,          /* Mapping change is complete.  */
48         RT_ADD,                 /* Beginning to add a new object.  */
49         RT_DELETE,              /* Beginning to remove an object mapping.  */
50       } r_state;
51
52     Elf32_Addr r_ldbase;        /* Base address the linker is loaded at.  */
53   };
54
55 /* This symbol refers to the "dynamic structure" in the `.dynamic' section
56    of whatever module refers to `_DYNAMIC'.  So, to find its own
57    `struct r_debug', a program could do:
58      for (dyn = _DYNAMIC; dyn->d_tag != DT_NULL)
59        if (dyn->d_tag == DT_DEBUG) r_debug = (struct r_debug) dyn->d_un.d_ptr;
60    */
61
62 extern Elf32_Dyn _DYNAMIC[];
63
64
65 /* Structure describing a loaded shared object.  The `l_next' and `l_prev'
66    members form a chain of all the shared objects loaded at startup.
67
68    These data structures exist in space used by the run-time dynamic linker;
69    modifying them may have disastrous results.  */
70
71 struct link_map
72   {
73     /* These first few members are part of the protocol with the debugger.
74        This is the same format used in SVR4.  */
75
76     Elf32_Addr l_addr;          /* Base address shared object is loaded at.  */
77     char *l_name;               /* Absolute file name object was found in.  */
78     Elf32_Dyn *l_ld;            /* Dynamic section of the shared object.  */
79     struct link_map *l_next, *l_prev; /* Chain of loaded objects.  */
80
81     /* All following members are internal to the dynamic linker.
82        They may change without notice.  */
83
84     const char *l_libname;      /* Name requested (before search).  */
85     Elf32_Dyn *l_info[DT_NUM];  /* Indexed pointers to dynamic section.  */
86     const Elf32_Phdr *l_phdr;   /* Pointer to program header table in core.  */
87     Elf32_Word l_phnum;         /* Number of program header entries.  */
88
89     /* Symbol hash table.  */
90     Elf32_Word l_nbuckets;
91     const Elf32_Word *l_buckets, *l_chain;
92
93     unsigned int l_opencount;   /* Reference count for dlopen/dlclose.  */
94     enum                        /* Where this object came from.  */
95       {
96         lt_executable,          /* The main executable program.  */
97         lt_interpreter,         /* The interpreter: the dynamic linker.  */
98         lt_library,             /* Library needed by main executable.  */
99         lt_loaded,              /* Extra run-time loaded shared object.  */
100       } l_type:2;
101     unsigned int l_deps_loaded:1; /* Nonzero if DT_NEEDED items loaded.  */
102     unsigned int l_relocated:1; /* Nonzero if object's relocations done.  */
103     unsigned int l_init_called:1; /* Nonzero if DT_INIT function called.  */
104     unsigned int l_init_running:1; /* Nonzero while DT_INIT function runs.  */
105   };
106 \f
107 /* Internal functions of the run-time dynamic linker.
108    These can be accessed if you link again the dynamic linker
109    as a shared library, as in `-lld' or `/lib/ld.so' explicitly;
110    but are not normally of interest to user programs.
111
112    The `-ldl' library functions in <dlfcn.h> provide a simple
113    user interface to run-time dynamic linking.  */
114
115
116 /* File descriptor referring to the zero-fill device.  */
117 extern int _dl_zerofd;
118
119 /* OS-dependent function to open the zero-fill device.  */
120 extern int _dl_sysdep_open_zero_fill (void); /* dl-sysdep.c */
121
122 /* OS-dependent function to give a fatal error message and exit
123    when the dynamic linker fails before the program is fully linked.
124    All arguments are `const char *'; args until a null pointer
125    are concatenated to form the message to print.  */
126 extern void _dl_sysdep_fatal (const char *string, ...)
127      __attribute__ ((__noreturn__));
128
129 /* Nonzero if the program should be "secure" (i.e. it's setuid or somesuch).
130    This tells the dynamic linker to ignore environment variables.  */
131 extern int _dl_secure;
132
133 /* This function is called by all the internal dynamic linker functions
134    when they encounter an error.  ERRCODE is either an `errno' code
135    or zero; ERRSTRING is a string describing the specific problem.  */
136    
137 extern void _dl_signal_error (int errcode, const char *errstring)
138      __attribute__ ((__noreturn__));
139
140 /* Call OPERATE, catching errors from `dl_signal_error'.  If there is no
141    error, *ERRSTRING is set to null.  If there is an error, *ERRSTRING is
142    set to the string passed to _dl_signal_error, and the error code passed
143    is the return value.  */
144 extern int _dl_catch_error (const char **errstring, void (*operate) (void));
145
146
147 /* Helper function for <dlfcn.h> functions.  Runs the OPERATE function via
148    _dl_catch_error.  Returns zero for success, nonzero for failure; and
149    arranges for `dlerror' to return the error details.  */
150 extern int _dlerror_run (void (*operate) (void));
151
152
153 /* Open the shared object NAME and map in its segments.
154    LOADER's DT_RPATH is used in searching for NAME.
155    If ENTRY_POINT is not null, fill it in with the object's entry point.
156    If the object is already opened, returns its existing map.  */
157 extern struct link_map *_dl_map_object (struct link_map *loader,
158                                         const char *name,
159                                         Elf32_Addr *entry_point);
160
161 /* Cache the locations of MAP's hash table.  */
162 extern void _dl_setup_hash (struct link_map *map);
163
164
165 /* Search loaded objects' symbol tables for a definition of the symbol
166    referred to by UNDEF.  *SYM is the symbol table entry containing the
167    reference; it is replaced with the defining symbol, and the base load
168    address of the defining object is returned.  SYMBOL_SCOPE is the head of
169    the chain used for searching.  */
170 extern Elf32_Addr _dl_lookup_symbol (const char *undef,
171                                      const Elf32_Sym **sym,
172                                      struct link_map *symbol_scope);
173
174
175 /* List of objects currently loaded.  */
176 extern struct link_map *_dl_loaded;
177
178 /* Tail of that list which were loaded at startup.  */
179 extern struct link_map *_dl_startup_loaded;
180
181 /* Allocate a `struct link_map' for a new object being loaded,
182    and enter it into the _dl_loaded list.  */
183 extern struct link_map *_dl_new_object (char *realname, const char *libname,
184                                         int type);
185
186 /* Relocate the given object (if it hasn't already been).
187    If LAZY is nonzero, don't relocate its PLT.  */
188 extern void _dl_relocate_object (struct link_map *map, int lazy);
189
190 /* Return the address of the next initializer function not yet run.
191    When there are no more initializers to be run, this returns zero.
192    The functions are returned in the order they should be called.  */
193 extern Elf32_Addr _dl_init_next (void);
194
195 /* Call the finalizer functions of all shared objects whose
196    initializer functions have completed.  */
197 extern void _dl_fini (void);
198
199 /* The dynamic linker calls this function before and having changing
200    any shared object mappings.  The `r_state' member of `struct r_debug'
201    says what change is taking place.  This function's address is
202    the value of the `r_brk' member.  */
203 extern void _dl_r_debug_state (void);
204
205
206 #endif /* link.h */