sys/sys/linker.h

   1 /*-
   2  * Copyright (c) 1997-2000 Doug Rabson
   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  *
  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
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _SYS_LINKER_H_
  30 #define _SYS_LINKER_H_
  31
  32 #ifdef _KERNEL
  33
  34 #include <machine/elf.h>
  35 #include <sys/kobj.h>
  36
  37 #ifdef MALLOC_DECLARE
  38 MALLOC_DECLARE(M_LINKER);
  39 #endif
  40
  41 struct mod_depend;
  42
  43 /*
  44  * Object representing a file which has been loaded by the linker.
  45  */
  46 typedef struct linker_file* linker_file_t;
  47 typedef TAILQ_HEAD(, linker_file) linker_file_list_t;
  48
  49 typedef caddr_t linker_sym_t;           /* opaque symbol */
  50 typedef c_caddr_t c_linker_sym_t;       /* const opaque symbol */
  51 typedef int (*linker_function_name_callback_t)(const char *, void *);
  52
  53 /*
  54  * expanded out linker_sym_t
  55  */
  56 typedef struct linker_symval {
  57     const char*         name;
  58     caddr_t             value;
  59     size_t              size;
  60 } linker_symval_t;
  61
  62 typedef int (*linker_function_nameval_callback_t)(linker_file_t, int, linker_symval_t *, void *);
  63
  64 struct common_symbol {
  65     STAILQ_ENTRY(common_symbol) link;
  66     char*               name;
  67     caddr_t             address;
  68 };
  69
  70 struct linker_file {
  71     KOBJ_FIELDS;
  72     int                 refs;           /* reference count */
  73     int                 userrefs;       /* kldload(2) count */
  74     int                 flags;
  75 #define LINKER_FILE_LINKED      0x1     /* file has been fully linked */
  76 #define LINKER_FILE_MODULES     0x2     /* file has >0 modules at preload */
  77     TAILQ_ENTRY(linker_file) link;      /* list of all loaded files */
  78     char*               filename;       /* file which was loaded */
  79     char*               pathname;       /* file name with full path */
  80     int                 id;             /* unique id */
  81     caddr_t             address;        /* load address */
  82     size_t              size;           /* size of file */
  83     caddr_t             ctors_addr;     /* address of .ctors */
  84     size_t              ctors_size;     /* size of .ctors */
  85     int                 ndeps;          /* number of dependencies */
  86     linker_file_t*      deps;           /* list of dependencies */
  87     STAILQ_HEAD(, common_symbol) common; /* list of common symbols */
  88     TAILQ_HEAD(, module) modules;       /* modules in this file */
  89     TAILQ_ENTRY(linker_file) loaded;    /* preload dependency support */
  90     int                 loadcnt;        /* load counter value */
  91
  92     /*
  93      * Function Boundary Tracing (FBT) or Statically Defined Tracing (SDT)
  94      * fields.
  95      */
  96     int                 nenabled;       /* number of enabled probes. */
  97     int                 fbt_nentries;   /* number of fbt entries created. */
  98 };
  99
 100 /*
 101  * Object implementing a class of file (a.out, elf, etc.)
 102  */
 103 typedef struct linker_class *linker_class_t;
 104 typedef TAILQ_HEAD(, linker_class) linker_class_list_t;
 105
 106 struct linker_class {
 107     KOBJ_CLASS_FIELDS;
 108     TAILQ_ENTRY(linker_class) link;     /* list of all file classes */
 109 };
 110
 111 /*
 112  * Function type used when iterating over the list of linker files.
 113  */
 114 typedef int linker_predicate_t(linker_file_t, void *);
 115
 116 /*
 117  * The "file" for the kernel.
 118  */
 119 extern linker_file_t    linker_kernel_file;
 120
 121 /*
 122  * Obtain a reference to a module, loading it if required.
 123  */
 124 int linker_reference_module(const char* _modname, struct mod_depend *_verinfo,
 125                             linker_file_t* _result);
 126
 127 /*
 128  * Release a reference to a module, unloading it if there are no more
 129  * references.  Note that one should either provide a module name and
 130  * optional version info or a linker file, but not both.
 131  */
 132 int linker_release_module(const char *_modname, struct mod_depend *_verinfo,
 133                           linker_file_t _file);
 134
 135 /*
 136  * Iterate over all of the currently loaded linker files calling the
 137  * predicate function while the function returns 0.  Returns the value
 138  * returned by the last predicate function.
 139  */
 140 int linker_file_foreach(linker_predicate_t *_predicate, void *_context);
 141
 142 /*
 143  * Lookup a symbol in a file.  If deps is TRUE, look in dependencies
 144  * if not found in file.
 145  */
 146 caddr_t linker_file_lookup_symbol(linker_file_t _file, const char* _name,
 147                                   int _deps);
 148
 149 /*
 150  * Lookup a linker set in a file.  Return pointers to the first entry,
 151  * last + 1, and count of entries.  Use: for (p = start; p < stop; p++) {}
 152  * void *start is really: "struct yoursetmember ***start;"
 153  */
 154 int linker_file_lookup_set(linker_file_t _file, const char *_name,
 155                            void *_start, void *_stop, int *_count);
 156
 157 /*
 158  * List all functions in a file.
 159  */
 160 int linker_file_function_listall(linker_file_t,
 161                                  linker_function_nameval_callback_t, void *);
 162
 163 /*
 164  * Functions solely for use by the linker class handlers.
 165  */
 166 int linker_add_class(linker_class_t _cls);
 167 int linker_file_unload(linker_file_t _file, int flags);
 168 int linker_load_dependencies(linker_file_t _lf);
 169 linker_file_t linker_make_file(const char* _filename, linker_class_t _cls);
 170
 171 /*
 172  * DDB Helpers, tuned specifically for ddb/db_kld.c
 173  */
 174 int linker_ddb_lookup(const char *_symstr, c_linker_sym_t *_sym);
 175 int linker_ddb_search_symbol(caddr_t _value, c_linker_sym_t *_sym,
 176                              long *_diffp);
 177 int linker_ddb_symbol_values(c_linker_sym_t _sym, linker_symval_t *_symval);
 178 int linker_ddb_search_symbol_name(caddr_t value, char *buf, u_int buflen,
 179                                   long *offset);
 180
 181 /*
 182  * stack(9) helper for situations where kernel locking is required.
 183  */
 184 int linker_search_symbol_name(caddr_t value, char *buf, u_int buflen,
 185     long *offset);
 186
 187
 188 /* HWPMC helper */
 189 void *linker_hwpmc_list_objects(void);
 190
 191 #endif  /* _KERNEL */
 192
 193 /*
 194  * Module information subtypes
 195  */
 196 #define MODINFO_END             0x0000          /* End of list */
 197 #define MODINFO_NAME            0x0001          /* Name of module (string) */
 198 #define MODINFO_TYPE            0x0002          /* Type of module (string) */
 199 #define MODINFO_ADDR            0x0003          /* Loaded address */
 200 #define MODINFO_SIZE            0x0004          /* Size of module */
 201 #define MODINFO_EMPTY           0x0005          /* Has been deleted */
 202 #define MODINFO_ARGS            0x0006          /* Parameters string */
 203 #define MODINFO_METADATA        0x8000          /* Module-specfic */
 204
 205 #define MODINFOMD_AOUTEXEC      0x0001          /* a.out exec header */
 206 #define MODINFOMD_ELFHDR        0x0002          /* ELF header */
 207 #define MODINFOMD_SSYM          0x0003          /* start of symbols */
 208 #define MODINFOMD_ESYM          0x0004          /* end of symbols */
 209 #define MODINFOMD_DYNAMIC       0x0005          /* _DYNAMIC pointer */
 210 /* These values are MD on these two platforms */
 211 #if !defined(__sparc64__) && !defined(__powerpc__)
 212 #define MODINFOMD_ENVP          0x0006          /* envp[] */
 213 #define MODINFOMD_HOWTO         0x0007          /* boothowto */
 214 #define MODINFOMD_KERNEND       0x0008          /* kernend */
 215 #endif
 216 #define MODINFOMD_SHDR          0x0009          /* section header table */
 217 #define MODINFOMD_CTORS_ADDR    0x000a          /* address of .ctors */
 218 #define MODINFOMD_CTORS_SIZE    0x000b          /* size of .ctors */
 219 #define MODINFOMD_FW_HANDLE     0x000c          /* Firmware dependent handle */
 220 #define MODINFOMD_KEYBUF        0x000d          /* Crypto key intake buffer */
 221 #define MODINFOMD_NOCOPY        0x8000          /* don't copy this metadata to the kernel */
 222
 223 #define MODINFOMD_DEPLIST       (0x4001 | MODINFOMD_NOCOPY)     /* depends on */
 224
 225 #ifdef _KERNEL
 226 #define MD_FETCH(mdp, info, type) ({ \
 227         type *__p; \
 228         __p = (type *)preload_search_info((mdp), MODINFO_METADATA | (info)); \
 229         __p ? *__p : 0; \
 230 })
 231 #endif
 232
 233 #define LINKER_HINTS_VERSION    1               /* linker.hints file version */
 234 #define LINKER_HINTS_MAX        (1 << 20)       /* Allow at most 1MB for linker.hints */
 235
 236 #ifdef _KERNEL
 237
 238 /*
 239  * Module lookup
 240  */
 241 extern vm_offset_t      preload_addr_relocate;
 242 extern caddr_t          preload_metadata;
 243
 244 extern void *           preload_fetch_addr(caddr_t _mod);
 245 extern size_t           preload_fetch_size(caddr_t _mod);
 246 extern caddr_t          preload_search_by_name(const char *_name);
 247 extern caddr_t          preload_search_by_type(const char *_type);
 248 extern caddr_t          preload_search_next_name(caddr_t _base);
 249 extern caddr_t          preload_search_info(caddr_t _mod, int _inf);
 250 extern void             preload_delete_name(const char *_name);
 251 extern void             preload_bootstrap_relocate(vm_offset_t _offset);
 252
 253 #ifdef KLD_DEBUG
 254
 255 extern int kld_debug;
 256 #define KLD_DEBUG_FILE  1       /* file load/unload */
 257 #define KLD_DEBUG_SYM   2       /* symbol lookup */
 258
 259 #define KLD_DPF(cat, args)                                      \
 260         do {                                                    \
 261                 if (kld_debug & KLD_DEBUG_##cat) printf args;   \
 262         } while (0)
 263
 264 #else
 265
 266 #define KLD_DPF(cat, args)
 267
 268 #endif
 269
 270 typedef int elf_lookup_fn(linker_file_t, Elf_Size, int, Elf_Addr *);
 271
 272 /* Support functions */
 273 int     elf_reloc(linker_file_t _lf, Elf_Addr base, const void *_rel, int _type, elf_lookup_fn _lu);
 274 int     elf_reloc_local(linker_file_t _lf, Elf_Addr base, const void *_rel, int _type, elf_lookup_fn _lu);
 275 Elf_Addr elf_relocaddr(linker_file_t _lf, Elf_Addr addr);
 276 const Elf_Sym *elf_get_sym(linker_file_t _lf, Elf_Size _symidx);
 277 const char *elf_get_symname(linker_file_t _lf, Elf_Size _symidx);
 278
 279 typedef struct linker_ctf {
 280         const uint8_t   *ctftab;        /* Decompressed CTF data. */
 281         int             ctfcnt;         /* Number of CTF data bytes. */
 282         const Elf_Sym   *symtab;        /* Ptr to the symbol table. */
 283         int             nsym;           /* Number of symbols. */
 284         const char      *strtab;        /* Ptr to the string table. */
 285         int             strcnt;         /* Number of string bytes. */
 286         uint32_t        **ctfoffp;      /* Ptr to array of obj/fnc offsets. */
 287         uint32_t        **typoffp;      /* Ptr to array of type offsets. */
 288         long            *typlenp;       /* Ptr to number of type data entries. */
 289 } linker_ctf_t;
 290
 291 int     linker_ctf_get(linker_file_t, linker_ctf_t *);
 292
 293 int elf_cpu_load_file(linker_file_t);
 294 int elf_cpu_unload_file(linker_file_t);
 295
 296 /* values for type */
 297 #define ELF_RELOC_REL   1
 298 #define ELF_RELOC_RELA  2
 299
 300 /*
 301  * This is version 1 of the KLD file status structure. It is identified
 302  * by its _size_ in the version field.
 303  */
 304 struct kld_file_stat_1 {
 305     int         version;        /* set to sizeof(struct kld_file_stat_1) */
 306     char        name[MAXPATHLEN];
 307     int         refs;
 308     int         id;
 309     caddr_t     address;        /* load address */
 310     size_t      size;           /* size in bytes */
 311 };
 312 #endif /* _KERNEL */
 313
 314 struct kld_file_stat {
 315     int         version;        /* set to sizeof(struct kld_file_stat) */
 316     char        name[MAXPATHLEN];
 317     int         refs;
 318     int         id;
 319     caddr_t     address;        /* load address */
 320     size_t      size;           /* size in bytes */
 321     char        pathname[MAXPATHLEN];
 322 };
 323
 324 struct kld_sym_lookup {
 325     int         version;        /* set to sizeof(struct kld_sym_lookup) */
 326     char        *symname;       /* Symbol name we are looking up */
 327     u_long      symvalue;
 328     size_t      symsize;
 329 };
 330 #define KLDSYM_LOOKUP   1
 331
 332 /*
 333  * Flags for kldunloadf() and linker_file_unload()
 334  */
 335 #define LINKER_UNLOAD_NORMAL    0
 336 #define LINKER_UNLOAD_FORCE     1
 337
 338 #ifndef _KERNEL
 339
 340 #include <sys/cdefs.h>
 341
 342 __BEGIN_DECLS
 343 int     kldload(const char* _file);
 344 int     kldunload(int _fileid);
 345 int     kldunloadf(int _fileid, int flags);
 346 int     kldfind(const char* _file);
 347 int     kldnext(int _fileid);
 348 int     kldstat(int _fileid, struct kld_file_stat* _stat);
 349 int     kldfirstmod(int _fileid);
 350 int     kldsym(int _fileid, int _cmd, void *_data);
 351 __END_DECLS
 352
 353 #endif
 354
 355 #endif /* !_SYS_LINKER_H_ */