dlfcn/dlfcn.h

   1 /* User functions for run-time dynamic loading.
   2    Copyright (C) 1995, 1996, 1997, 1998, 1999 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 #define __need_NULL
  25 #include <stddef.h>
  26
  27 /* Collect various system dependent definitions and declarations.  */
  28 #include <bits/dlfcn.h>
  29
  30 #ifdef __USE_GNU
  31 /* If the first argument of `dlsym' or `dlvsym' is set to RTLD_NEXT
  32    the run-time address of the symbol called NAME in the next shared
  33    object is returned.  The "next" relation is defined by the order
  34    the shared objects were loaded.  */
  35 # define RTLD_NEXT      ((void *) -1l)
  36
  37 /* If the first argument to `dlsym' or `dlvsym' is set to RTLD_DEFAULT
  38    the run-time address of the symbol called NAME in the global scope
  39    is returned.  */
  40 # define RTLD_DEFAULT   NULL
  41 #endif
  42
  43 __BEGIN_DECLS
  44
  45 /* Open the shared object FILE and map it in; return a handle that can be
  46    passed to `dlsym' to get symbol values from it.  */
  47 extern void *dlopen __P ((__const char *__file, int __mode));
  48
  49 /* Unmap and close a shared object opened by `dlopen'.
  50    The handle cannot be used again after calling `dlclose'.  */
  51 extern int dlclose __P ((void *__handle));
  52
  53 /* Find the run-time address in the shared object HANDLE refers to
  54    of the symbol called NAME.  */
  55 extern void *dlsym __P ((void *__restrict __handle,
  56                          __const char *__restrict __name));
  57
  58 #ifdef __USE_GNU
  59 /* Find the run-time address in the shared object HANDLE refers to
  60    of the symbol called NAME with VERSION.  */
  61 extern void *dlvsym __P ((void *__restrict __handle,
  62                           __const char *__restrict __name,
  63                           __const char *__restrict __version));
  64 #endif
  65
  66 /* When any of the above functions fails, call this function
  67    to return a string describing the error.  Each call resets
  68    the error string so that a following call returns null.  */
  69 extern char *dlerror __P ((void));
  70
  71 #ifdef __USE_GNU
  72 /* Fill in *INFO with the following information about ADDRESS.
  73    Returns 0 iff no shared object's segments contain that address.  */
  74 typedef struct
  75   {
  76     __const char *dli_fname;    /* File name of defining object.  */
  77     void *dli_fbase;            /* Load address of that object.  */
  78     __const char *dli_sname;    /* Name of nearest symbol.  */
  79     void *dli_saddr;            /* Exact value of nearest symbol.  */
  80   } Dl_info;
  81 extern int dladdr __P ((const void *__address, Dl_info *__info));
  82
  83 /* To support profiling of shared objects it is a good idea to call
  84    the function found using `dlsym' using the following macro since
  85    these calls do not use the PLT.  But this would mean the dynamic
  86    loader has no chance to find out when the function is called.  The
  87    macro applies the necessary magic so that profiling is possible.
  88    Rewrite
  89         foo = (*fctp) (arg1, arg2);
  90    into
  91         foo = DL_CALL_FCT (fctp, (arg1, arg2));
  92 */
  93 # define DL_CALL_FCT(fctp, args) \
  94   (_dl_mcount_wrapper_check (fctp), (*(fctp)) args)
  95
  96 /* This function calls the profiling functions.  */
  97 extern void _dl_mcount_wrapper_check __P ((void *__selfpc));
  98 #endif
  99
 100 __END_DECLS
 101
 102 #endif  /* dlfcn.h */