sys/kern/linker_if.m

   1 #-
   2 # Copyright (c) 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 #include <sys/linker.h>
  30
  31 INTERFACE linker;
  32
  33 #
  34 # Lookup a symbol in the file's symbol table.  If the symbol is not
  35 # found then return ENOENT, otherwise zero.
  36 #
  37 METHOD int lookup_symbol {
  38     linker_file_t       file;
  39     const char*         name;
  40     c_linker_sym_t*     symp;
  41 };
  42
  43 METHOD int symbol_values {
  44     linker_file_t       file;
  45     c_linker_sym_t      sym;
  46     linker_symval_t*    valp;
  47 };
  48
  49 METHOD int search_symbol {
  50     linker_file_t       file;
  51     caddr_t             value;
  52     c_linker_sym_t*     symp;
  53     long*               diffp;
  54 };
  55
  56 #
  57 # Call the callback with each specified function defined in the file.
  58 # Stop and return the error if the callback returns an error.
  59 #
  60 METHOD int each_function_name {
  61         linker_file_t   file;
  62         linker_function_name_callback_t callback;
  63         void*           opaque;
  64 };
  65
  66 #
  67 # Search for a linker set in a file.  Return a pointer to the first
  68 # entry (which is itself a pointer), and the number of entries.
  69 # "stop" points to the entry beyond the last valid entry.
  70 # If count, start or stop are NULL, they are not returned.
  71 #
  72 METHOD int lookup_set {
  73     linker_file_t       file;
  74     const char*         name;
  75     void***             start;
  76     void***             stop;
  77     int*                count;
  78 };
  79
  80 #
  81 # Unload a file, releasing dependancies and freeing storage.
  82 #
  83 METHOD void unload {
  84     linker_file_t       file;
  85 };
  86
  87 #
  88 # Load a file, returning the new linker_file_t in *result.  If
  89 # the class does not recognise the file type, zero should be
  90 # returned, without modifying *result.  If the file is
  91 # recognised, the file should be loaded, *result set to the new
  92 # file and zero returned.  If some other error is detected an
  93 # appropriate errno should be returned.
  94 #
  95 STATICMETHOD int load_file {
  96     linker_class_t      cls;
  97     const char*         filename;
  98     linker_file_t*      result;
  99 };
 100 STATICMETHOD int link_preload {
 101     linker_class_t      cls;
 102     const char*         filename;
 103     linker_file_t*      result;
 104 };
 105 METHOD int link_preload_finish {
 106     linker_file_t       file;
 107 };