dlfcn.h 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. /* User functions for run-time dynamic loading.
  2. Copyright (C) 1995-2001,2003,2004,2006,2009 Free Software Foundation, Inc.
  3. This file is part of the GNU C Library.
  4. The GNU C Library is free software; you can redistribute it and/or
  5. modify it under the terms of the GNU Lesser General Public
  6. License as published by the Free Software Foundation; either
  7. version 2.1 of the License, or (at your option) any later version.
  8. The GNU C Library is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. Lesser General Public License for more details.
  12. You should have received a copy of the GNU Lesser General Public
  13. License along with the GNU C Library; if not, see
  14. <http://www.gnu.org/licenses/>. */
  15. #ifndef _DLFCN_H
  16. #define _DLFCN_H 1
  17. #include <features.h>
  18. #define __need_size_t
  19. #include <stddef.h>
  20. /* Collect various system dependent definitions and declarations. */
  21. #include <bits/dlfcn.h>
  22. #ifdef __USE_GNU
  23. /* If the first argument of `dlsym' or `dlvsym' is set to RTLD_NEXT
  24. the run-time address of the symbol called NAME in the next shared
  25. object is returned. The "next" relation is defined by the order
  26. the shared objects were loaded. */
  27. # define RTLD_NEXT ((void *) -1l)
  28. /* If the first argument to `dlsym' or `dlvsym' is set to RTLD_DEFAULT
  29. the run-time address of the symbol called NAME in the global scope
  30. is returned. */
  31. # define RTLD_DEFAULT ((void *) 0)
  32. # if 0 /* uClibc doesnt support this */
  33. /* Type for namespace indeces. */
  34. typedef long int Lmid_t;
  35. /* Special namespace ID values. */
  36. # define LM_ID_BASE 0 /* Initial namespace. */
  37. # define LM_ID_NEWLM -1 /* For dlmopen: request new namespace. */
  38. # endif
  39. #endif
  40. __BEGIN_DECLS
  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 (const char *__file, int __mode) __THROW;
  44. /* Unmap and close a shared object opened by `dlopen'.
  45. The handle cannot be used again after calling `dlclose'. */
  46. extern int dlclose (void *__handle) __THROW __nonnull ((1));
  47. /* Find the run-time address in the shared object HANDLE refers to
  48. of the symbol called NAME. */
  49. extern void *dlsym (void *__restrict __handle,
  50. const char *__restrict __name) __THROW __nonnull ((2));
  51. #if 0 /*def __USE_GNU*/
  52. /* Like `dlopen', but request object to be allocated in a new namespace. */
  53. extern void *dlmopen (Lmid_t __nsid, const char *__file, int __mode) __THROW;
  54. /* Find the run-time address in the shared object HANDLE refers to
  55. of the symbol called NAME with VERSION. */
  56. extern void *dlvsym (void *__restrict __handle,
  57. const char *__restrict __name,
  58. const char *__restrict __version)
  59. __THROW __nonnull ((2, 3));
  60. #endif
  61. /* When any of the above functions fails, call this function
  62. to return a string describing the error. Each call resets
  63. the error string so that a following call returns null. */
  64. extern char *dlerror (void) __THROW;
  65. #ifdef __USE_GNU
  66. /* Structure containing information about object searched using
  67. `dladdr'. */
  68. typedef struct
  69. {
  70. const char *dli_fname; /* File name of defining object. */
  71. void *dli_fbase; /* Load address of that object. */
  72. const char *dli_sname; /* Name of nearest symbol. */
  73. void *dli_saddr; /* Exact value of nearest symbol. */
  74. } Dl_info;
  75. /* Fill in *INFO with the following information about ADDRESS.
  76. Returns 0 iff no shared object's segments contain that address. */
  77. extern int dladdr (const void *__address, Dl_info *__info)
  78. __THROW __nonnull ((2));
  79. #if 0 /* not supported by uClibc */
  80. /* Same as `dladdr', but additionally sets *EXTRA_INFO according to FLAGS. */
  81. extern int dladdr1 (const void *__address, Dl_info *__info,
  82. void **__extra_info, int __flags) __THROW __nonnull ((2));
  83. /* These are the possible values for the FLAGS argument to `dladdr1'.
  84. This indicates what extra information is stored at *EXTRA_INFO.
  85. It may also be zero, in which case the EXTRA_INFO argument is not used. */
  86. enum
  87. {
  88. /* Matching symbol table entry (const ElfNN_Sym *). */
  89. RTLD_DL_SYMENT = 1,
  90. /* The object containing the address (struct link_map *). */
  91. RTLD_DL_LINKMAP = 2
  92. };
  93. /* Get information about the shared object HANDLE refers to.
  94. REQUEST is from among the values below, and determines the use of ARG.
  95. On success, returns zero. On failure, returns -1 and records an error
  96. message to be fetched with `dlerror'. */
  97. extern int dlinfo (void *__restrict __handle,
  98. int __request, void *__restrict __arg)
  99. __THROW __nonnull ((1, 3));
  100. /* These are the possible values for the REQUEST argument to `dlinfo'. */
  101. enum
  102. {
  103. /* Treat ARG as `lmid_t *'; store namespace ID for HANDLE there. */
  104. RTLD_DI_LMID = 1,
  105. /* Treat ARG as `struct link_map **';
  106. store the `struct link_map *' for HANDLE there. */
  107. RTLD_DI_LINKMAP = 2,
  108. RTLD_DI_CONFIGADDR = 3, /* Unsupported, defined by Solaris. */
  109. /* Treat ARG as `Dl_serinfo *' (see below), and fill in to describe the
  110. directories that will be searched for dependencies of this object.
  111. RTLD_DI_SERINFOSIZE fills in just the `dls_cnt' and `dls_size'
  112. entries to indicate the size of the buffer that must be passed to
  113. RTLD_DI_SERINFO to fill in the full information. */
  114. RTLD_DI_SERINFO = 4,
  115. RTLD_DI_SERINFOSIZE = 5,
  116. /* Treat ARG as `char *', and store there the directory name used to
  117. expand $ORIGIN in this shared object's dependency file names. */
  118. RTLD_DI_ORIGIN = 6,
  119. RTLD_DI_PROFILENAME = 7, /* Unsupported, defined by Solaris. */
  120. RTLD_DI_PROFILEOUT = 8, /* Unsupported, defined by Solaris. */
  121. /* Treat ARG as `size_t *', and store there the TLS module ID
  122. of this object's PT_TLS segment, as used in TLS relocations;
  123. store zero if this object does not define a PT_TLS segment. */
  124. RTLD_DI_TLS_MODID = 9,
  125. /* Treat ARG as `void **', and store there a pointer to the calling
  126. thread's TLS block corresponding to this object's PT_TLS segment.
  127. Store a null pointer if this object does not define a PT_TLS
  128. segment, or if the calling thread has not allocated a block for it. */
  129. RTLD_DI_TLS_DATA = 10,
  130. RTLD_DI_MAX = 10
  131. };
  132. /* This is the type of elements in `Dl_serinfo', below.
  133. The `dls_name' member points to space in the buffer passed to `dlinfo'. */
  134. typedef struct
  135. {
  136. char *dls_name; /* Name of library search path directory. */
  137. unsigned int dls_flags; /* Indicates where this directory came from. */
  138. } Dl_serpath;
  139. /* This is the structure that must be passed (by reference) to `dlinfo' for
  140. the RTLD_DI_SERINFO and RTLD_DI_SERINFOSIZE requests. */
  141. typedef struct
  142. {
  143. size_t dls_size; /* Size in bytes of the whole buffer. */
  144. unsigned int dls_cnt; /* Number of elements in `dls_serpath'. */
  145. Dl_serpath dls_serpath[1]; /* Actually longer, dls_cnt elements. */
  146. } Dl_serinfo;
  147. #endif
  148. #endif /* __USE_GNU */
  149. __END_DECLS
  150. #endif /* dlfcn.h */