2 * Copyright (c) 1997 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/sys/sys/linker.h,v 1.17.2.1 2002/03/11 01:13:53 dd Exp $
27 * $DragonFly: src/sys/sys/linker.h,v 1.11 2008/02/06 22:37:46 nth Exp $
30 #ifndef _SYS_LINKER_H_
31 #define _SYS_LINKER_H_
34 #include <sys/types.h>
37 #include <sys/param.h>
43 #include <sys/queue.h>
45 #ifndef _MACHINE_ELF_H_
46 #include <machine/elf.h>
50 MALLOC_DECLARE(M_LINKER
);
54 * Object representing a file which has been loaded by the linker.
56 typedef struct linker_file
* linker_file_t
;
57 typedef TAILQ_HEAD(, linker_file
) linker_file_list_t
;
59 typedef caddr_t linker_sym_t
; /* opaque symbol */
60 typedef c_caddr_t c_linker_sym_t
; /* const opaque symbol */
63 * expanded out linker_sym_t
65 typedef struct linker_symval
{
71 struct linker_file_ops
{
73 * Lookup a symbol in the file's symbol table. If the symbol is
74 * not found then return ENOENT, otherwise zero. If the symbol
75 * found is a common symbol, return with *address set to zero and
76 * *size set to the size of the common space required. Otherwise
77 * set *address the value of the symbol.
79 int (*lookup_symbol
)(linker_file_t
, const char* name
,
82 int (*symbol_values
)(linker_file_t
, c_linker_sym_t
,
85 int (*search_symbol
)(linker_file_t
, caddr_t value
,
86 c_linker_sym_t
* sym
, long* diffp
);
89 * Unload a file, releasing dependancies and freeing storage.
91 void (*unload
)(linker_file_t
);
93 int (*lookup_set
)(linker_file_t
, const char *name
,
94 void ***firstp
, void ***lastp
, int *countp
);
97 struct common_symbol
{
98 STAILQ_ENTRY(common_symbol
) link
;
104 int refs
; /* reference count */
105 int userrefs
; /* kldload(2) count */
107 #define LINKER_FILE_LINKED 0x1 /* file has been fully linked */
108 TAILQ_ENTRY(linker_file
) link
; /* list of all loaded files */
109 char* filename
; /* file which was loaded */
110 int id
; /* unique id */
111 caddr_t address
; /* load address */
112 size_t size
; /* size of file */
113 int ndeps
; /* number of dependancies */
114 linker_file_t
* deps
; /* list of dependancies */
115 STAILQ_HEAD(, common_symbol
) common
; /* list of common symbols */
116 TAILQ_HEAD(, module
) modules
; /* modules in this file */
117 void* priv
; /* implementation data */
119 struct linker_file_ops
* ops
;
123 * Object implementing a class of file (a.out, elf, etc.)
125 typedef struct linker_class
*linker_class_t
;
126 typedef TAILQ_HEAD(, linker_class
) linker_class_list_t
;
128 struct linker_class_ops
{
130 * Load a file, returning the new linker_file_t in *result. If
131 * the class does not recognise the file type, zero should be
132 * returned, without modifying *result. If the file is
133 * recognised, the file should be loaded, *result set to the new
134 * file and zero returned. If some other error is detected an
135 * appropriate errno should be returned.
137 int (*load_file
)(const char* filename
, linker_file_t
* result
);
140 struct linker_class
{
141 TAILQ_ENTRY(linker_class
) link
; /* list of all file classes */
142 const char* desc
; /* description (e.g. "a.out") */
143 void* priv
; /* implementation data */
145 struct linker_class_ops
*ops
;
149 * The file which is currently loading. Used to register modules with
150 * the files which contain them.
152 extern linker_file_t linker_current_file
;
155 * The "file" for the kernel.
157 extern linker_file_t linker_kernel_file
;
160 * Add a new file class to the linker.
162 int linker_add_class(const char* _desc
, void* _priv
,
163 struct linker_class_ops
* _ops
);
166 * Load a file, trying each file class until one succeeds.
168 int linker_load_file(const char* _filename
, linker_file_t
* _result
);
171 * Find a currently loaded file given its filename.
173 linker_file_t
linker_find_file_by_name(const char* _filename
);
176 * Find a currently loaded file given its file id.
178 linker_file_t
linker_find_file_by_id(int _fileid
);
181 * Called from a class handler when a file is laoded.
183 linker_file_t
linker_make_file(const char* _filename
, void* _priv
,
184 struct linker_file_ops
* _ops
);
187 * Unload a file, freeing up memory.
189 int linker_file_unload(linker_file_t _file
);
192 * Add a dependancy to a file.
194 void linker_file_add_dependancy(linker_file_t _file
, linker_file_t _dep
);
197 * Lookup a symbol in a file. If deps is TRUE, look in dependancies
198 * if not found in file. The symbol's value is returned in the
199 * caddr_t. An error is returned, 0 if no error occured.
201 int linker_file_lookup_symbol(linker_file_t _file
, const char* _name
,
202 int _deps
, caddr_t
*);
206 * Lookup a linker set in a file. Return pointers to the first entry,
207 * last + 1, and count of entries. Use: for (p = start; p < stop; p++) {}
208 * void *start is really: "struct yoursetmember ***start;"
210 int linker_file_lookup_set(linker_file_t _file
, const char *_name
,
211 void *_start
, void *_stop
, int *_count
);
214 * Search the linker path for the module. Return the full pathname in
215 * a malloc'ed buffer.
217 char *linker_search_path(const char *_filename
);
220 * DDB Helpers, tuned specifically for ddb/db_kld.c
222 int linker_ddb_lookup(const char *_symstr
, c_linker_sym_t
*_sym
);
223 int linker_ddb_search_symbol(caddr_t _value
, c_linker_sym_t
*_sym
,
225 int linker_ddb_symbol_values(c_linker_sym_t _sym
, linker_symval_t
*_symval
);
231 * Module information subtypes
233 #define MODINFO_END 0x0000 /* End of list */
234 #define MODINFO_NAME 0x0001 /* Name of module (string) */
235 #define MODINFO_TYPE 0x0002 /* Type of module (string) */
236 #define MODINFO_ADDR 0x0003 /* Loaded address */
237 #define MODINFO_SIZE 0x0004 /* Size of module */
238 #define MODINFO_EMPTY 0x0005 /* Has been deleted */
239 #define MODINFO_ARGS 0x0006 /* Parameters string */
240 #define MODINFO_METADATA 0x8000 /* Module-specfic */
242 #define MODINFOMD_AOUTEXEC 0x0001 /* a.out exec header */
243 #define MODINFOMD_ELFHDR 0x0002 /* ELF header */
244 #define MODINFOMD_SSYM 0x0003 /* start of symbols */
245 #define MODINFOMD_ESYM 0x0004 /* end of symbols */
246 #define MODINFOMD_DYNAMIC 0x0005 /* _DYNAMIC pointer */
247 #define MODINFOMD_ENVP 0x0006 /* (from 5.x) envp[] */
248 #define MODINFOMD_HOWTO 0x0007 /* (from 5.x) boothowto */
249 #define MODINFOMD_KERNEND 0x0008 /* (from 5.x) kernend */
250 #define MODINFOMD_NOCOPY 0x8000 /* don't copy this metadata to the kernel */
252 #define MODINFOMD_DEPLIST (0x4001 | MODINFOMD_NOCOPY) /* depends on */
255 #define MD_FETCH(mdp, info, type) ({ \
257 __p = (type *)preload_search_info((mdp), MODINFO_METADATA | (info)); \
262 #define LINKER_HINTS_VERSION 1 /* linker.hints file version */
269 extern caddr_t preload_metadata
;
270 extern caddr_t
preload_search_by_name(const char *);
271 extern caddr_t
preload_search_by_type(const char *);
272 extern caddr_t
preload_search_next_name(caddr_t
);
273 extern caddr_t
preload_search_info(caddr_t
, int);
274 extern void preload_delete_name(const char *);
275 extern void preload_bootstrap_relocate(vm_offset_t
);
276 extern struct mod_metadata
*find_mod_metadata(const char *);
281 extern int kld_debug
;
282 #define KLD_DEBUG_FILE 1 /* file load/unload */
283 #define KLD_DEBUG_SYM 2 /* symbol lookup */
285 #define KLD_DPF(cat, args) \
287 if (kld_debug & KLD_DEBUG_##cat) kprintf args; \
292 #define KLD_DPF(cat, args)
296 /* Support functions */
297 int elf_reloc(linker_file_t
, const void *, int, const char *);
299 /* values for type */
300 #define ELF_RELOC_REL 1
301 #define ELF_RELOC_RELA 2
305 struct kld_file_stat
{
306 int version
; /* set to sizeof(linker_file_stat) */
307 char name
[MAXPATHLEN
];
310 caddr_t address
; /* load address */
311 size_t size
; /* size in bytes */
314 struct kld_sym_lookup
{
315 int version
; /* set to sizeof(struct kld_sym_lookup) */
316 const char *symname
; /* Symbol name we are looking up */
321 #define KLDSYM_LOOKUP 1
325 #ifndef _SYS_CDEFS_H_
326 #include <sys/cdefs.h>
330 int kldload(const char *);
332 int kldfind(const char *);
334 int kldstat(int, struct kld_file_stat
*);
335 int kldfirstmod(int);
336 int kldsym(int, int, void *);
341 #endif /* !_SYS_LINKER_H_ */