The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/linker.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    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 struct common_symbol {
   63     STAILQ_ENTRY(common_symbol) link;
   64     char*               name;
   65     caddr_t             address;
   66 };
   67 
   68 struct linker_file {
   69     KOBJ_FIELDS;
   70     int                 refs;           /* reference count */
   71     int                 userrefs;       /* kldload(2) count */
   72     int                 flags;
   73 #define LINKER_FILE_LINKED      0x1     /* file has been fully linked */
   74     TAILQ_ENTRY(linker_file) link;      /* list of all loaded files */
   75     char*               filename;       /* file which was loaded */
   76     char*               pathname;       /* file name with full path */
   77     int                 id;             /* unique id */
   78     caddr_t             address;        /* load address */
   79     size_t              size;           /* size of file */
   80     int                 ndeps;          /* number of dependencies */
   81     linker_file_t*      deps;           /* list of dependencies */
   82     STAILQ_HEAD(, common_symbol) common; /* list of common symbols */
   83     TAILQ_HEAD(, module) modules;       /* modules in this file */
   84     TAILQ_ENTRY(linker_file) loaded;    /* preload dependency support */
   85     int                 loadcnt;        /* load counter value */
   86 
   87     /*
   88      * Function Boundary Tracing (FBT) or Statically Defined Tracing (SDT)
   89      * fields.
   90      */
   91     int                 nenabled;       /* number of enabled probes. */
   92     int                 fbt_nentries;   /* number of fbt entries created. */
   93     void                *sdt_probes;
   94     int                 sdt_nentries;
   95     size_t              sdt_nprobes;
   96     size_t              sdt_size;
   97 };
   98 
   99 /*
  100  * Object implementing a class of file (a.out, elf, etc.)
  101  */
  102 typedef struct linker_class *linker_class_t;
  103 typedef TAILQ_HEAD(, linker_class) linker_class_list_t;
  104 
  105 struct linker_class {
  106     KOBJ_CLASS_FIELDS;
  107     TAILQ_ENTRY(linker_class) link;     /* list of all file classes */
  108 };
  109 
  110 /*
  111  * The "file" for the kernel.
  112  */
  113 extern linker_file_t    linker_kernel_file;
  114 
  115 /*
  116  * Add a new file class to the linker.
  117  */
  118 int linker_add_class(linker_class_t _cls);
  119 
  120 /*
  121  * Load a kernel module.
  122  */
  123 int linker_load_module(const char *_kldname, const char *_modname,
  124     struct linker_file *_parent, struct mod_depend *_verinfo,
  125     struct linker_file **_lfpp);
  126 
  127 /*
  128  * Obtain a reference to a module, loading it if required.
  129  */
  130 int linker_reference_module(const char* _modname, struct mod_depend *_verinfo,
  131                             linker_file_t* _result);
  132 
  133 /*
  134  * Release a reference to a module, unloading it if there are no more
  135  * references.  Note that one should either provide a module name and
  136  * optional version info or a linker file, but not both.
  137  */
  138 int linker_release_module(const char *_modname, struct mod_depend *_verinfo,
  139                             linker_file_t _file);
  140 
  141 /*
  142  * Find a currently loaded file given its filename.
  143  */
  144 linker_file_t linker_find_file_by_name(const char* _filename);
  145 
  146 /*
  147  * Find a currently loaded file given its file id.
  148  */
  149 linker_file_t linker_find_file_by_id(int _fileid);
  150 
  151 /*
  152  * Called from a class handler when a file is laoded.
  153  */
  154 linker_file_t linker_make_file(const char* _filename, linker_class_t _cls);
  155 
  156 /*
  157  * Unload a file, freeing up memory.
  158  */
  159 int linker_file_unload(linker_file_t _file, int flags);
  160 
  161 /*
  162  * Add a dependency to a file.
  163  */
  164 int linker_file_add_dependency(linker_file_t _file, linker_file_t _dep);
  165 
  166 /*
  167  * Lookup a symbol in a file.  If deps is TRUE, look in dependencies
  168  * if not found in file.
  169  */
  170 caddr_t linker_file_lookup_symbol(linker_file_t _file, const char* _name, 
  171                                   int _deps);
  172 
  173 /*
  174  * Lookup a linker set in a file.  Return pointers to the first entry,
  175  * last + 1, and count of entries.  Use: for (p = start; p < stop; p++) {}
  176  * void *start is really: "struct yoursetmember ***start;"
  177  */
  178 int linker_file_lookup_set(linker_file_t _file, const char *_name,
  179                            void *_start, void *_stop, int *_count);
  180 
  181 /*
  182  * This routine is responsible for finding dependencies of userland
  183  * initiated kldload(2)'s of files.
  184  */
  185 int linker_load_dependencies(linker_file_t _lf);
  186 
  187 /*
  188  * DDB Helpers, tuned specifically for ddb/db_kld.c
  189  */
  190 int linker_ddb_lookup(const char *_symstr, c_linker_sym_t *_sym);
  191 int linker_ddb_search_symbol(caddr_t _value, c_linker_sym_t *_sym,
  192                              long *_diffp);
  193 int linker_ddb_symbol_values(c_linker_sym_t _sym, linker_symval_t *_symval);
  194 
  195 
  196 #endif  /* _KERNEL */
  197 
  198 /*
  199  * Module information subtypes
  200  */
  201 #define MODINFO_END             0x0000          /* End of list */
  202 #define MODINFO_NAME            0x0001          /* Name of module (string) */
  203 #define MODINFO_TYPE            0x0002          /* Type of module (string) */
  204 #define MODINFO_ADDR            0x0003          /* Loaded address */
  205 #define MODINFO_SIZE            0x0004          /* Size of module */
  206 #define MODINFO_EMPTY           0x0005          /* Has been deleted */
  207 #define MODINFO_ARGS            0x0006          /* Parameters string */
  208 #define MODINFO_METADATA        0x8000          /* Module-specfic */
  209 
  210 #define MODINFOMD_AOUTEXEC      0x0001          /* a.out exec header */
  211 #define MODINFOMD_ELFHDR        0x0002          /* ELF header */
  212 #define MODINFOMD_SSYM          0x0003          /* start of symbols */
  213 #define MODINFOMD_ESYM          0x0004          /* end of symbols */
  214 #define MODINFOMD_DYNAMIC       0x0005          /* _DYNAMIC pointer */
  215 /* These values are MD on these two platforms */
  216 #if !defined(__sparc64__) && !defined(__powerpc__)
  217 #define MODINFOMD_ENVP          0x0006          /* envp[] */
  218 #define MODINFOMD_HOWTO         0x0007          /* boothowto */
  219 #define MODINFOMD_KERNEND       0x0008          /* kernend */
  220 #endif
  221 #define MODINFOMD_SHDR          0x0009          /* section header table */
  222 #define MODINFOMD_NOCOPY        0x8000          /* don't copy this metadata to the kernel */
  223 
  224 #define MODINFOMD_DEPLIST       (0x4001 | MODINFOMD_NOCOPY)     /* depends on */
  225 
  226 #ifdef _KERNEL
  227 #define MD_FETCH(mdp, info, type) ({ \
  228         type *__p; \
  229         __p = (type *)preload_search_info((mdp), MODINFO_METADATA | (info)); \
  230         __p ? *__p : 0; \
  231 })
  232 #endif
  233 
  234 #define LINKER_HINTS_VERSION    1               /* linker.hints file version */
  235 
  236 #ifdef _KERNEL
  237 
  238 /*
  239  * Module lookup
  240  */
  241 extern caddr_t          preload_metadata;
  242 extern caddr_t          preload_search_by_name(const char *_name);
  243 extern caddr_t          preload_search_by_type(const char *_type);
  244 extern caddr_t          preload_search_next_name(caddr_t _base);
  245 extern caddr_t          preload_search_info(caddr_t _mod, int _inf);
  246 extern void             preload_delete_name(const char *_name);
  247 extern void             preload_bootstrap_relocate(vm_offset_t _offset);
  248 
  249 #ifdef KLD_DEBUG
  250 
  251 extern int kld_debug;
  252 #define KLD_DEBUG_FILE  1       /* file load/unload */
  253 #define KLD_DEBUG_SYM   2       /* symbol lookup */
  254 
  255 #define KLD_DPF(cat, args)                                      \
  256         do {                                                    \
  257                 if (kld_debug & KLD_DEBUG_##cat) printf args;   \
  258         } while (0)
  259 
  260 #else
  261 
  262 #define KLD_DPF(cat, args)
  263 
  264 #endif
  265 
  266 typedef Elf_Addr elf_lookup_fn(linker_file_t, Elf_Size, int);
  267 
  268 /* Support functions */
  269 int     elf_reloc(linker_file_t _lf, Elf_Addr base, const void *_rel, int _type, elf_lookup_fn _lu);
  270 int     elf_reloc_local(linker_file_t _lf, Elf_Addr base, const void *_rel, int _type, elf_lookup_fn _lu);
  271 const Elf_Sym *elf_get_sym(linker_file_t _lf, Elf_Size _symidx);
  272 const char *elf_get_symname(linker_file_t _lf, Elf_Size _symidx);
  273 
  274 int elf_cpu_load_file(linker_file_t);
  275 int elf_cpu_unload_file(linker_file_t);
  276 
  277 /* values for type */
  278 #define ELF_RELOC_REL   1
  279 #define ELF_RELOC_RELA  2
  280 
  281 /*
  282  * This is version 1 of the KLD file status structure. It is identified
  283  * by it's _size_ in the version field.
  284  */
  285 struct kld_file_stat_1 {
  286     int         version;        /* set to sizeof(linker_file_stat) */
  287     char        name[MAXPATHLEN];
  288     int         refs;
  289     int         id;
  290     caddr_t     address;        /* load address */
  291     size_t      size;           /* size in bytes */
  292 };
  293 #endif /* _KERNEL */
  294 
  295 struct kld_file_stat {
  296     int         version;        /* set to sizeof(linker_file_stat) */
  297     char        name[MAXPATHLEN];
  298     int         refs;
  299     int         id;
  300     caddr_t     address;        /* load address */
  301     size_t      size;           /* size in bytes */
  302     char        pathname[MAXPATHLEN];
  303 };
  304 
  305 struct kld_sym_lookup {
  306     int         version;        /* set to sizeof(struct kld_sym_lookup) */
  307     char        *symname;       /* Symbol name we are looking up */
  308     u_long      symvalue;
  309     size_t      symsize;
  310 };
  311 #define KLDSYM_LOOKUP   1
  312 
  313 /*
  314  * Flags for kldunloadf() and linker_file_unload()
  315  */
  316 #define LINKER_UNLOAD_NORMAL    0
  317 #define LINKER_UNLOAD_FORCE     1
  318 
  319 #ifndef _KERNEL
  320 
  321 #include <sys/cdefs.h>
  322 
  323 __BEGIN_DECLS
  324 int     kldload(const char* _file);
  325 int     kldunload(int _fileid);
  326 int     kldunloadf(int _fileid, int flags);
  327 int     kldfind(const char* _file);
  328 int     kldnext(int _fileid);
  329 int     kldstat(int _fileid, struct kld_file_stat* _stat);
  330 int     kldfirstmod(int _fileid);
  331 int     kldsym(int _fileid, int _cmd, void *_data);
  332 __END_DECLS
  333 
  334 #endif
  335 
  336 #endif /* !_SYS_LINKER_H_ */

Cache object: 077aa969b291594c5977b8b26f72ee53


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.