Merge branch 'vendor/MPFR' into gcc441
[dragonfly.git] / sys / sys / link_aout.h
1 /*
2  * Copyright (c) 1993 Paul Kranenburg
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by Paul Kranenburg.
16  * 4. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  * $FreeBSD: src/sys/sys/link_aout.h,v 1.20.2.1 2000/09/22 02:08:25 jdp Exp $
31  * $DragonFly: src/sys/sys/link_aout.h,v 1.3 2003/08/20 07:31:21 rob Exp $
32  */
33
34 /*
35  * RRS section definitions.
36  *
37  * The layout of some data structures defined in this header file is
38  * such that we can provide compatibility with the SunOS 4.x shared
39  * library scheme.
40  */
41
42 #ifndef _LINK_H_
43 #define _LINK_H_
44
45 #if (defined(FREEBSD_ELF) || defined(__ELF__)) && !defined(FREEBSD_AOUT)
46
47 #include <sys/types.h>
48
49 struct link_map {
50         caddr_t         l_addr;                 /* Base Address of library */
51 #ifdef __mips__
52         caddr_t         l_offs;                 /* Load Offset of library */
53 #endif
54         const char      *l_name;                /* Absolute Path to Library */
55         const void      *l_ld;                  /* Pointer to .dynamic in memory */
56         struct link_map *l_next, *l_prev;       /* linked list of of mapped libs */
57 };
58
59 struct r_debug {
60         int             r_version;              /* not used */
61         struct link_map *r_map;                 /* list of loaded images */
62         void            (*r_brk)(struct r_debug *, struct link_map *);
63                                                 /* pointer to break point */
64         enum {
65             RT_CONSISTENT,                      /* things are stable */
66             RT_ADD,                             /* adding a shared library */
67             RT_DELETE                           /* removing a shared library */
68         }               r_state;
69 };
70
71 #else /* !__ELF__ */
72
73 struct dl_info;
74
75 /*
76  * A `Shared Object Descriptor' describes a shared object that is needed
77  * to complete the link edit process of the object containing it.
78  * A list of such objects (chained through `sod_next') is pointed at
79  * by `sdt_sods' in the section_dispatch_table structure.
80  */
81
82 struct sod {    /* Shared Object Descriptor */
83         long    sod_name;               /* name (relative to load address) */
84         u_int   sod_library  : 1,       /* Searched for by library rules */
85                 sod_reserved : 31;
86         short   sod_major;              /* major version number */
87         short   sod_minor;              /* minor version number */
88         long    sod_next;               /* next sod */
89 };
90
91 /*
92  * `Shared Object Map's are used by the run-time link editor (ld.so) to
93  * keep track of all shared objects loaded into a process' address space.
94  * These structures are only used at run-time and do not occur within
95  * the text or data segment of an executable or shared library.
96  */
97 struct so_map {         /* Shared Object Map */
98         caddr_t         som_addr;       /* Address at which object mapped */
99         char            *som_path;      /* Path to mmap'ed file */
100         struct so_map   *som_next;      /* Next map in chain */
101         struct sod      *som_sod;       /* Sod responsible for this map */
102         caddr_t         som_sodbase;    /* Base address of this sod */
103         u_int           som_write : 1;  /* Text is currently writable */
104         struct _dynamic *som_dynamic;   /* _dynamic structure */
105         caddr_t         som_spd;        /* Private data */
106 };
107
108 /*
109  * Symbol description with size. This is simply an `nlist' with
110  * one field (nz_size) added.
111  * Used to convey size information on items in the data segment
112  * of shared objects. An array of these live in the shared object's
113  * text segment and is addressed by the `sdt_nzlist' field.
114  */
115 struct nzlist {
116         struct nlist    nlist;
117         u_long          nz_size;
118 };
119
120 #define nz_un           nlist.n_un
121 #define nz_strx         nlist.n_un.n_strx
122 #define nz_name         nlist.n_un.n_name
123 #define nz_type         nlist.n_type
124 #define nz_value        nlist.n_value
125 #define nz_desc         nlist.n_desc
126 #define nz_other        nlist.n_other
127
128 /*
129  * The `section_dispatch_table' structure contains offsets to various data
130  * structures needed to do run-time relocation.
131  */
132 struct section_dispatch_table {
133         struct so_map *sdt_loaded;      /* List of loaded objects */
134         long    sdt_sods;               /* List of shared objects descriptors */
135         long    sdt_paths;              /* Library search paths */
136         long    sdt_got;                /* Global offset table */
137         long    sdt_plt;                /* Procedure linkage table */
138         long    sdt_rel;                /* Relocation table */
139         long    sdt_hash;               /* Symbol hash table */
140         long    sdt_nzlist;             /* Symbol table itself */
141         long    sdt_filler2;            /* Unused (was: stab_hash) */
142         long    sdt_buckets;            /* Number of hash buckets */
143         long    sdt_strings;            /* Symbol strings */
144         long    sdt_str_sz;             /* Size of symbol strings */
145         long    sdt_text_sz;            /* Size of text area */
146         long    sdt_plt_sz;             /* Size of procedure linkage table */
147 };
148
149 /*
150  * RRS symbol hash table, addressed by `sdt_hash' in section_dispatch_table.
151  * Used to quickly lookup symbols of the shared object by hashing
152  * on the symbol's name. `rh_symbolnum' is the index of the symbol
153  * in the shared object's symbol list (`sdt_nzlist'), `rh_next' is
154  * the next symbol in the hash bucket (in case of collisions).
155  */
156 struct rrs_hash {
157         int     rh_symbolnum;           /* Symbol number */
158         int     rh_next;                /* Next hash entry */
159 };
160
161 /*
162  * `rt_symbols' is used to keep track of run-time allocated commons
163  * and data items copied from shared objects.
164  */
165 struct rt_symbol {
166         struct nzlist           *rt_sp;         /* The symbol */
167         struct rt_symbol        *rt_next;       /* Next in linear list */
168         struct rt_symbol        *rt_link;       /* Next in bucket */
169         caddr_t                 rt_srcaddr;     /* Address of "master" copy */
170         struct so_map           *rt_smp;        /* Originating map */
171 };
172
173 /*
174  * Debugger interface structure.
175  */
176 struct so_debug {
177         int     dd_version;             /* Version # of interface */
178         int     dd_in_debugger;         /* Set when run by debugger */
179         int     dd_sym_loaded;          /* Run-time linking brought more
180                                            symbols into scope */
181         char     *dd_bpt_addr;          /* Address of rtld-generated bpt */
182         int     dd_bpt_shadow;          /* Original contents of bpt */
183         struct rt_symbol *dd_cc;        /* Allocated commons/copied data */
184 };
185
186 /*
187  * Version returned to crt0 from ld.so
188  */
189 #define LDSO_VERSION_NONE       0       /* FreeBSD2.0, 2.0.5 */
190 #define LDSO_VERSION_HAS_DLEXIT 1       /* includes dlexit in ld_entry */
191 #define LDSO_VERSION_HAS_DLSYM3 2       /* includes 3-argument dlsym */
192 #define LDSO_VERSION_HAS_DLADDR 3       /* includes dladdr in ld_entry */
193
194 /*
195  * Entry points into ld.so - user interface to the run-time linker.
196  * Entries are valid for the given version numbers returned by ld.so
197  * to crt0.
198  */
199 struct ld_entry {
200         void    *(*dlopen) (const char *, int); /* NONE */
201         int     (*dlclose) (void *);            /* NONE */
202         void    *(*dlsym) (void *, const char *);       /* NONE */
203         const char *(*dlerror) (void);          /* NONE */
204         void    (*dlexit) (void);                       /* HAS_DLEXIT */
205         void    *(*dlsym3) (void *, const char *, void *); /* HAS_DLSYM3 */
206         int      (*dladdr) (const void *,
207                                 struct dl_info *);      /* HAS_DLADDR */
208 };
209
210 /*
211  * This is the structure pointed at by the __DYNAMIC symbol if an
212  * executable requires the attention of the run-time link editor.
213  * __DYNAMIC is given the value zero if no run-time linking needs to
214  * be done (it is always present in shared objects).
215  * The union `d_un' provides for different versions of the dynamic
216  * linking mechanism (switched on by `d_version'). The last version
217  * used by Sun is 3. We leave some room here and go to version number
218  * 8 for NetBSD, the main difference lying in the support for the
219  * `nz_list' type of symbols.
220  */
221
222 struct  _dynamic {
223         int             d_version;      /* version # of this interface */
224         struct so_debug *d_debug;
225         union {
226                 struct section_dispatch_table *d_sdt;
227         } d_un;
228         struct ld_entry *d_entry;       /* XXX */
229 };
230
231 #define LD_VERSION_SUN          (3)
232 #define LD_VERSION_BSD          (8)
233 #define LD_VERSION_NZLIST_P(v)  ((v) >= 8)
234
235 #define LD_GOT(x)       ((x)->d_un.d_sdt->sdt_got)
236 #define LD_PLT(x)       ((x)->d_un.d_sdt->sdt_plt)
237 #define LD_REL(x)       ((x)->d_un.d_sdt->sdt_rel)
238 #define LD_SYMBOL(x)    ((x)->d_un.d_sdt->sdt_nzlist)
239 #define LD_HASH(x)      ((x)->d_un.d_sdt->sdt_hash)
240 #define LD_STRINGS(x)   ((x)->d_un.d_sdt->sdt_strings)
241 #define LD_NEED(x)      ((x)->d_un.d_sdt->sdt_sods)
242 #define LD_BUCKETS(x)   ((x)->d_un.d_sdt->sdt_buckets)
243 #define LD_PATHS(x)     ((x)->d_un.d_sdt->sdt_paths)
244
245 #define LD_GOTSZ(x)     ((x)->d_un.d_sdt->sdt_plt - (x)->d_un.d_sdt->sdt_got)
246 #define LD_RELSZ(x)     ((x)->d_un.d_sdt->sdt_hash - (x)->d_un.d_sdt->sdt_rel)
247 #define LD_HASHSZ(x)    ((x)->d_un.d_sdt->sdt_nzlist - (x)->d_un.d_sdt->sdt_hash)
248 #define LD_STABSZ(x)    ((x)->d_un.d_sdt->sdt_strings - (x)->d_un.d_sdt->sdt_nzlist)
249 #define LD_PLTSZ(x)     ((x)->d_un.d_sdt->sdt_plt_sz)
250 #define LD_STRSZ(x)     ((x)->d_un.d_sdt->sdt_str_sz)
251 #define LD_TEXTSZ(x)    ((x)->d_un.d_sdt->sdt_text_sz)
252
253 /*
254  * Interface to ld.so
255  */
256 struct crt_ldso {
257         int             crt_ba;         /* Base address of ld.so */
258         int             crt_dzfd;       /* "/dev/zero" file descriptor (SunOS) */
259         int             crt_ldfd;       /* ld.so file descriptor */
260         struct _dynamic *crt_dp;        /* Main's __DYNAMIC */
261         char            **crt_ep;       /* environment strings */
262         caddr_t         crt_bp;         /* Breakpoint if run from debugger */
263         char            *crt_prog;      /* Program name (v3) */
264         char            *crt_ldso;      /* Link editor name (v4) */
265         struct ld_entry *crt_ldentry;   /* dl*() access (v4) */
266         char            **crt_argv;     /* argument strings (v5) */
267 };
268
269 /*
270  * Version passed from crt0 to ld.so (1st argument to _rtld()).
271  */
272 #define CRT_VERSION_SUN         1
273 #define CRT_VERSION_BSD_2       2
274 #define CRT_VERSION_BSD_3       3
275 #define CRT_VERSION_BSD_4       4
276 #define CRT_VERSION_BSD_5       5
277
278 /*
279  * Maximum number of recognized shared object version numbers.
280  */
281 #define MAXDEWEY        8
282
283 /*
284  * Header of the hints file.
285  */
286 struct hints_header {
287         long            hh_magic;
288 #define HH_MAGIC        011421044151
289         long            hh_version;     /* Interface version number */
290 #define LD_HINTS_VERSION_1      1
291 #define LD_HINTS_VERSION_2      2
292         long            hh_hashtab;     /* Location of hash table */
293         long            hh_nbucket;     /* Number of buckets in hashtab */
294         long            hh_strtab;      /* Location of strings */
295         long            hh_strtab_sz;   /* Size of strings */
296         long            hh_ehints;      /* End of hints (max offset in file) */
297         long            hh_dirlist;     /* Colon-separated list of srch dirs */
298 };
299
300 #define HH_BADMAG(hdr)  ((hdr).hh_magic != HH_MAGIC)
301
302 /*
303  * Hash table element in hints file.
304  */
305 struct hints_bucket {
306         /* namex and pathx are indices into the string table */
307         int             hi_namex;               /* Library name */
308         int             hi_pathx;               /* Full path */
309         int             hi_dewey[MAXDEWEY];     /* The versions */
310         int             hi_ndewey;              /* Number of version numbers */
311 #define hi_major hi_dewey[0]
312 #define hi_minor hi_dewey[1]
313         int             hi_next;                /* Next in this bucket */
314 };
315
316 #define _PATH_LD_HINTS          "/var/run/ld.so.hints"
317
318 #endif /* !__ELF__ */
319
320 #endif /* _LINK_H_ */