include/dlfcn.h

   1 /* User functions for run-time dynamic loading.
   2    Copyright (C) 1995-1999, 2000 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Library General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Library General Public License for more details.
  14
  15    You should have received a copy of the GNU Library General Public
  16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18    Boston, MA 02111-1307, USA.  */
  19
  20 #ifndef _DLFCN_H
  21 #define _DLFCN_H 1
  22
  23 #include <features.h>
  24
  25 /* Collect various system dependent definitions and declarations.  */
  26 #include <bits/dlfcn.h>
  27
  28 /* If the first argument of `dlsym' or `dlvsym' is set to RTLD_NEXT
  29    the run-time address of the symbol called NAME in the next shared
  30    object is returned.  The "next" relation is defined by the order
  31    the shared objects were loaded.  */
  32 #define RTLD_NEXT       ((void *) -1l)
  33
  34 /* If the first argument to `dlsym' or `dlvsym' is set to RTLD_DEFAULT
  35    the run-time address of the symbol called NAME in the global scope
  36    is returned.  */
  37 #define RTLD_DEFAULT    ((void *) 0)
  38
  39 __BEGIN_DECLS
  40
  41 /* Open the shared object FILE and map it in; return a handle that can be
  42    passed to `dlsym' to get symbol values from it.  */
  43 extern void *dlopen __P ((__const char *__file, int __mode));
  44
  45 /* Unmap and close a shared object opened by `dlopen'.
  46    The handle cannot be used again after calling `dlclose'.  */
  47 extern int dlclose __P ((void *__handle));
  48
  49 /* Find the run-time address in the shared object HANDLE refers to
  50    of the symbol called NAME.  */
  51 extern void *dlsym __P ((void *__restrict __handle,
  52                          __const char *__restrict __name));
  53
  54 #ifdef __USE_GNU
  55 /* Find the run-time address in the shared object HANDLE refers to
  56    of the symbol called NAME with VERSION.  */
  57 extern void *dlvsym __P ((void *__restrict __handle,
  58                           __const char *__restrict __name,
  59                           __const char *__restrict __version));
  60 #endif
  61
  62 /* When any of the above functions fails, call this function
  63    to return a string describing the error.  Each call resets
  64    the error string so that a following call returns null.  */
  65 extern char *dlerror __P ((void));
  66
  67 #ifdef __USE_GNU
  68 /* Fill in *INFO with the following information about ADDRESS.
  69    Returns 0 iff no shared object's segments contain that address.  */
  70 typedef struct
  71   {
  72     __const char *dli_fname;    /* File name of defining object.  */
  73     void *dli_fbase;            /* Load address of that object.  */
  74     __const char *dli_sname;    /* Name of nearest symbol.  */
  75     void *dli_saddr;            /* Exact value of nearest symbol.  */
  76   } Dl_info;
  77 extern int dladdr __P ((const void *__address, Dl_info *__info));
  78
  79 /* To support profiling of shared objects it is a good idea to call
  80    the function found using `dlsym' using the following macro since
  81    these calls do not use the PLT.  But this would mean the dynamic
  82    loader has no chance to find out when the function is called.  The
  83    macro applies the necessary magic so that profiling is possible.
  84    Rewrite
  85         foo = (*fctp) (arg1, arg2);
  86    into
  87         foo = DL_CALL_FCT (fctp, (arg1, arg2));
  88 */
  89 # define DL_CALL_FCT(fctp, args) \
  90   (_dl_mcount_wrapper_check (fctp), (*(fctp)) args)
  91
  92 /* This function calls the profiling functions.  */
  93 extern void _dl_mcount_wrapper_check __P ((void *__selfpc));
  94 #endif
  95
  96 __END_DECLS
  97
  98 #endif  /* dlfcn.h */