/include/dlfcn.h

https://bitbucket.org/freebsd/freebsd-head/ · C Header · 137 lines · 66 code · 16 blank · 55 comment · 0 complexity · 00765a9cff075bc02c1d973ad6e89611 MD5 · raw file

  1. /*-
  2. * Copyright (c) 1994
  3. * The Regents of the University of California. 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. * 3. Neither the name of the University nor the names of its contributors
  14. * may be used to endorse or promote products derived from this software
  15. * without specific prior written permission.
  16. *
  17. * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20. * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27. * SUCH DAMAGE.
  28. *
  29. * $FreeBSD$
  30. */
  31. #ifndef _DLFCN_H_
  32. #define _DLFCN_H_
  33. #include <sys/_types.h>
  34. /*
  35. * Modes and flags for dlopen().
  36. */
  37. #define RTLD_LAZY 1 /* Bind function calls lazily. */
  38. #define RTLD_NOW 2 /* Bind function calls immediately. */
  39. #define RTLD_MODEMASK 0x3
  40. #define RTLD_GLOBAL 0x100 /* Make symbols globally available. */
  41. #define RTLD_LOCAL 0 /* Opposite of RTLD_GLOBAL, and the default. */
  42. #define RTLD_TRACE 0x200 /* Trace loaded objects and exit. */
  43. #define RTLD_NODELETE 0x01000 /* Do not remove members. */
  44. #define RTLD_NOLOAD 0x02000 /* Do not load if not already loaded. */
  45. /*
  46. * Request arguments for dlinfo().
  47. */
  48. #define RTLD_DI_LINKMAP 2 /* Obtain link map. */
  49. #define RTLD_DI_SERINFO 4 /* Obtain search path info. */
  50. #define RTLD_DI_SERINFOSIZE 5 /* ... query for required space. */
  51. #define RTLD_DI_ORIGIN 6 /* Obtain object origin */
  52. #define RTLD_DI_MAX RTLD_DI_ORIGIN
  53. /*
  54. * Special handle arguments for dlsym()/dlinfo().
  55. */
  56. #define RTLD_NEXT ((void *) -1) /* Search subsequent objects. */
  57. #define RTLD_DEFAULT ((void *) -2) /* Use default search algorithm. */
  58. #define RTLD_SELF ((void *) -3) /* Search the caller itself. */
  59. #if __BSD_VISIBLE
  60. #ifndef _SIZE_T_DECLARED
  61. typedef __size_t size_t;
  62. #define _SIZE_T_DECLARED
  63. #endif
  64. /*
  65. * Structure filled in by dladdr().
  66. */
  67. typedef struct dl_info {
  68. const char *dli_fname; /* Pathname of shared object. */
  69. void *dli_fbase; /* Base address of shared object. */
  70. const char *dli_sname; /* Name of nearest symbol. */
  71. void *dli_saddr; /* Address of nearest symbol. */
  72. } Dl_info;
  73. /*-
  74. * The actual type declared by this typedef is immaterial, provided that
  75. * it is a function pointer. Its purpose is to provide a return type for
  76. * dlfunc() which can be cast to a function pointer type without depending
  77. * on behavior undefined by the C standard, which might trigger a compiler
  78. * diagnostic. We intentionally declare a unique type signature to force
  79. * a diagnostic should the application not cast the return value of dlfunc()
  80. * appropriately.
  81. */
  82. struct __dlfunc_arg {
  83. int __dlfunc_dummy;
  84. };
  85. typedef void (*dlfunc_t)(struct __dlfunc_arg);
  86. /*
  87. * Structures, returned by the RTLD_DI_SERINFO dlinfo() request.
  88. */
  89. typedef struct dl_serpath {
  90. char * dls_name; /* single search path entry */
  91. unsigned int dls_flags; /* path information */
  92. } Dl_serpath;
  93. typedef struct dl_serinfo {
  94. size_t dls_size; /* total buffer size */
  95. unsigned int dls_cnt; /* number of path entries */
  96. Dl_serpath dls_serpath[1]; /* there may be more than one */
  97. } Dl_serinfo;
  98. #endif /* __BSD_VISIBLE */
  99. __BEGIN_DECLS
  100. /* XSI functions first. */
  101. int dlclose(void *);
  102. char *dlerror(void);
  103. void *dlopen(const char *, int);
  104. void *dlsym(void * __restrict, const char * __restrict);
  105. #if __BSD_VISIBLE
  106. void *fdlopen(int, int);
  107. int dladdr(const void * __restrict, Dl_info * __restrict);
  108. dlfunc_t dlfunc(void * __restrict, const char * __restrict);
  109. int dlinfo(void * __restrict, int, void * __restrict);
  110. void dllockinit(void *_context,
  111. void *(*_lock_create)(void *_context),
  112. void (*_rlock_acquire)(void *_lock),
  113. void (*_wlock_acquire)(void *_lock),
  114. void (*_lock_release)(void *_lock),
  115. void (*_lock_destroy)(void *_lock),
  116. void (*_context_destroy)(void *_context));
  117. void *dlvsym(void * __restrict, const char * __restrict,
  118. const char * __restrict);
  119. #endif /* __BSD_VISIBLE */
  120. __END_DECLS
  121. #endif /* !_DLFCN_H_ */