include/mach-o/dyld.h

   1 /*
   2  * Copyright (c) 1999-2008 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 #ifndef _MACH_O_DYLD_H_
  24 #define _MACH_O_DYLD_H_
  25
  26
  27 #include <stddef.h>
  28 #include <stdint.h>
  29 #include <stdbool.h>
  30
  31 #include <mach-o/loader.h>
  32 #include <Availability.h>
  33
  34 #if __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /*
  39  * The following functions allow you to iterate through all loaded images.
  40  * This is not a thread safe operation.  Another thread can add or remove
  41  * an image during the iteration.
  42  *
  43  * Many uses of these routines can be replace by a call to dladdr() which
  44  * will return the mach_header and name of an image, given an address in
  45  * the image. dladdr() is thread safe.
  46  */
  47 extern uint32_t                    _dyld_image_count(void)                              __OSX_AVAILABLE_STARTING(__MAC_10_1, __IPHONE_2_0);
  48 extern const struct mach_header*   _dyld_get_image_header(uint32_t image_index)         __OSX_AVAILABLE_STARTING(__MAC_10_1, __IPHONE_2_0);
  49 extern intptr_t                    _dyld_get_image_vmaddr_slide(uint32_t image_index)   __OSX_AVAILABLE_STARTING(__MAC_10_1, __IPHONE_2_0);
  50 extern const char*                 _dyld_get_image_name(uint32_t image_index)           __OSX_AVAILABLE_STARTING(__MAC_10_1, __IPHONE_2_0);
  51
  52
  53 /*
  54  * The following functions allow you to install callbacks which will be called
  55  * by dyld whenever an image is loaded or unloaded.  During a call to _dyld_register_func_for_add_image()
  56  * the callback func is called for every existing image.  Later, it is called as each new image
  57  * is loaded and bound (but initializers not yet run).  The callback registered with
  58  * _dyld_register_func_for_remove_image() is called after any terminators in an image are run
  59  * and before the image is un-memory-mapped.
  60  */
  61 extern void _dyld_register_func_for_add_image(void (*func)(const struct mach_header* mh, intptr_t vmaddr_slide))    __OSX_AVAILABLE_STARTING(__MAC_10_1, __IPHONE_2_0);
  62 extern void _dyld_register_func_for_remove_image(void (*func)(const struct mach_header* mh, intptr_t vmaddr_slide)) __OSX_AVAILABLE_STARTING(__MAC_10_1, __IPHONE_2_0);
  63
  64
  65 /*
  66  * NSVersionOfRunTimeLibrary() returns the current_version number of the currently dylib
  67  * specifed by the libraryName.  The libraryName parameter would be "bar" for /path/libbar.3.dylib and
  68  * "Foo" for /path/Foo.framework/Versions/A/Foo.  It returns -1 if no such library is loaded.
  69  */
  70 extern int32_t NSVersionOfRunTimeLibrary(const char* libraryName)            __OSX_AVAILABLE_STARTING(__MAC_10_1, __IPHONE_2_0);
  71
  72
  73 /*
  74  * NSVersionOfLinkTimeLibrary() returns the current_version number that the main executable was linked
  75  * against at build time.  The libraryName parameter would be "bar" for /path/libbar.3.dylib and
  76  * "Foo" for /path/Foo.framework/Versions/A/Foo.  It returns -1 if the main executable did not link
  77  * against the specified library.
  78  */
  79 extern int32_t NSVersionOfLinkTimeLibrary(const char* libraryName)           __OSX_AVAILABLE_STARTING(__MAC_10_1, __IPHONE_2_0);
  80
  81
  82 /*
  83  * _NSGetExecutablePath() copies the path of the main executable into the buffer. The bufsize parameter
  84  * should initially be the size of the buffer.  The function returns 0 if the path was successfully copied,
  85  * and *bufsize is left unchanged. It returns -1 if the buffer is not large enough, and *bufsize is set
  86  * to the size required.
  87  *
  88  * Note that _NSGetExecutablePath will return "a path" to the executable not a "real path" to the executable.
  89  * That is the path may be a symbolic link and not the real file. With deep directories the total bufsize
  90  * needed could be more than MAXPATHLEN.
  91  */
  92 extern int _NSGetExecutablePath(char* buf, uint32_t* bufsize)                 __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_2_0);
  93
  94
  95
  96 /*
  97  * Registers a function to be called when the current thread terminates.
  98  * Called by c++ compiler to implement destructors on thread_local object variables.
  99  */
 100 extern void _tlv_atexit(void (*termFunc)(void* objAddr), void* objAddr)      __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
 101
 102
 103 /*
 104  * Never called. On-disk thread local variables contain a pointer to this.  Once
 105  * the thread local is prepared, the pointer changes to a real handler such as tlv_get_addr.
 106  */
 107 extern void _tlv_bootstrap()                                                 __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
 108
 109
 110 // FIXME: remove when Availability.h updated
 111 #ifndef __BRIDGEOS_UNAVAILABLE
 112     #ifdef __ENVIRONMENT_BRIDGE_OS_VERSION_MIN_REQUIRED__
 113         #define __BRIDGEOS_UNAVAILABLE   __OS_AVAILABILITY(bridgeos,unavailable)
 114     #else
 115         #define __BRIDGEOS_UNAVAILABLE
 116     #endif
 117 #endif
 118
 119 /*
 120  * The following dyld API's are deprecated as of Mac OS X 10.5.  They are either
 121  * no longer necessary or are superceeded by dlopen and friends in <dlfcn.h>.
 122  * dlopen/dlsym/dlclose have been available since Mac OS X 10.3 and work with
 123  * dylibs and bundles.
 124  *
 125  *    NSAddImage                           -> dlopen
 126  *    NSLookupSymbolInImage                -> dlsym
 127  *    NSCreateObjectFileImageFromFile      -> dlopen
 128  *    NSDestroyObjectFileImage             -> dlclose
 129  *    NSLinkModule                         -> not needed when dlopen used
 130  *    NSUnLinkModule                       -> not needed when dlclose used
 131  *    NSLookupSymbolInModule               -> dlsym
 132  *    _dyld_image_containing_address       -> dladdr
 133  *    NSLinkEditError                      -> dlerror
 134  *
 135  */
 136
 137 #ifndef ENUM_DYLD_BOOL
 138 #define ENUM_DYLD_BOOL
 139   #undef FALSE
 140   #undef TRUE
 141   enum DYLD_BOOL { FALSE, TRUE };
 142 #endif /* ENUM_DYLD_BOOL */
 143
 144
 145 /* Object file image API */
 146 typedef enum {
 147     NSObjectFileImageFailure, /* for this a message is printed on stderr */
 148     NSObjectFileImageSuccess,
 149     NSObjectFileImageInappropriateFile,
 150     NSObjectFileImageArch,
 151     NSObjectFileImageFormat, /* for this a message is printed on stderr */
 152     NSObjectFileImageAccess
 153 } NSObjectFileImageReturnCode;
 154
 155 typedef struct __NSObjectFileImage*  NSObjectFileImage;
 156
 157
 158
 159 /* NSObjectFileImage can only be used with MH_BUNDLE files */
 160 extern NSObjectFileImageReturnCode NSCreateObjectFileImageFromFile(const char* pathName, NSObjectFileImage *objectFileImage)               __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "dlopen()");
 161 extern NSObjectFileImageReturnCode NSCreateObjectFileImageFromMemory(const void *address, size_t size, NSObjectFileImage *objectFileImage) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "");
 162 extern bool                        NSDestroyObjectFileImage(NSObjectFileImage objectFileImage)                                             __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "dlclose()");
 163
 164 extern uint32_t     NSSymbolDefinitionCountInObjectFileImage(NSObjectFileImage objectFileImage)                   __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "");
 165 extern const char*  NSSymbolDefinitionNameInObjectFileImage(NSObjectFileImage objectFileImage, uint32_t ordinal)  __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "");
 166 extern uint32_t     NSSymbolReferenceCountInObjectFileImage(NSObjectFileImage objectFileImage)                    __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "");
 167 extern const char*  NSSymbolReferenceNameInObjectFileImage(NSObjectFileImage objectFileImage, uint32_t ordinal, bool *tentative_definition) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "");
 168 extern bool         NSIsSymbolDefinedInObjectFileImage(NSObjectFileImage objectFileImage, const char* symbolName) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.4, "dlsym()");
 169 extern void*        NSGetSectionDataInObjectFileImage(NSObjectFileImage objectFileImage, const char* segmentName, const char* sectionName, size_t *size) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "getsectiondata()");
 170
 171 typedef struct __NSModule* NSModule;
 172 extern const char*  NSNameOfModule(NSModule m)         __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "");
 173 extern const char*  NSLibraryNameForModule(NSModule m) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "");
 174
 175 extern NSModule NSLinkModule(NSObjectFileImage objectFileImage, const char* moduleName, uint32_t options) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "dlopen()");
 176 #define NSLINKMODULE_OPTION_NONE                         0x0
 177 #define NSLINKMODULE_OPTION_BINDNOW                      0x1
 178 #define NSLINKMODULE_OPTION_PRIVATE                      0x2
 179 #define NSLINKMODULE_OPTION_RETURN_ON_ERROR              0x4
 180 #define NSLINKMODULE_OPTION_DONT_CALL_MOD_INIT_ROUTINES  0x8
 181 #define NSLINKMODULE_OPTION_TRAILING_PHYS_NAME          0x10
 182
 183 extern bool NSUnLinkModule(NSModule module, uint32_t options) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "");
 184 #define NSUNLINKMODULE_OPTION_NONE                  0x0
 185 #define NSUNLINKMODULE_OPTION_KEEP_MEMORY_MAPPED    0x1
 186 #define NSUNLINKMODULE_OPTION_RESET_LAZY_REFERENCES     0x2
 187
 188 /* symbol API */
 189 typedef struct __NSSymbol* NSSymbol;
 190 extern bool     NSIsSymbolNameDefined(const char* symbolName)                                                    __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.4, "dlsym()");
 191 extern bool     NSIsSymbolNameDefinedWithHint(const char* symbolName, const char* libraryNameHint)               __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.4, "dlsym()");
 192 extern bool     NSIsSymbolNameDefinedInImage(const struct mach_header* image, const char* symbolName)            __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.4, "dlsym()");
 193 extern NSSymbol NSLookupAndBindSymbol(const char* symbolName)                                                    __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.4, "dlsym()");
 194 extern NSSymbol NSLookupAndBindSymbolWithHint(const char* symbolName, const char* libraryNameHint)               __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.4, "dlsym()");
 195 extern NSSymbol NSLookupSymbolInModule(NSModule module, const char* symbolName)                                  __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "dlsym()");
 196 extern NSSymbol NSLookupSymbolInImage(const struct mach_header* image, const char* symbolName, uint32_t options) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "dlsym()");
 197 #define NSLOOKUPSYMBOLINIMAGE_OPTION_BIND            0x0
 198 #define NSLOOKUPSYMBOLINIMAGE_OPTION_BIND_NOW        0x1
 199 #define NSLOOKUPSYMBOLINIMAGE_OPTION_BIND_FULLY      0x2
 200 #define NSLOOKUPSYMBOLINIMAGE_OPTION_RETURN_ON_ERROR 0x4
 201 extern const char*  NSNameOfSymbol(NSSymbol symbol)    __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "");
 202 extern void *       NSAddressOfSymbol(NSSymbol symbol) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "dlsym()");
 203 extern NSModule     NSModuleForSymbol(NSSymbol symbol) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "dladdr()");
 204
 205 /* error handling API */
 206 typedef enum {
 207     NSLinkEditFileAccessError,
 208     NSLinkEditFileFormatError,
 209     NSLinkEditMachResourceError,
 210     NSLinkEditUnixResourceError,
 211     NSLinkEditOtherError,
 212     NSLinkEditWarningError,
 213     NSLinkEditMultiplyDefinedError,
 214     NSLinkEditUndefinedError
 215 } NSLinkEditErrors;
 216
 217 /*
 218  * For the NSLinkEditErrors value NSLinkEditOtherError these are the values
 219  * passed to the link edit error handler as the errorNumber (what would be an
 220  * errno value for NSLinkEditUnixResourceError or a kern_return_t value for
 221  * NSLinkEditMachResourceError).
 222  */
 223 typedef enum {
 224     NSOtherErrorRelocation,
 225     NSOtherErrorLazyBind,
 226     NSOtherErrorIndrLoop,
 227     NSOtherErrorLazyInit,
 228     NSOtherErrorInvalidArgs
 229 } NSOtherErrorNumbers;
 230
 231 extern void NSLinkEditError(NSLinkEditErrors *c, int *errorNumber, const char** fileName, const char** errorString) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "dlerror()");
 232
 233 typedef struct {
 234      void     (*undefined)(const char* symbolName);
 235      NSModule (*multiple)(NSSymbol s, NSModule oldModule, NSModule newModule);
 236      void     (*linkEdit)(NSLinkEditErrors errorClass, int errorNumber,
 237                           const char* fileName, const char* errorString);
 238 } NSLinkEditErrorHandlers;
 239
 240 extern void NSInstallLinkEditErrorHandlers(const NSLinkEditErrorHandlers *handlers) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "");
 241
 242 extern bool                      NSAddLibrary(const char* pathName)                   __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.4, "dlopen()");
 243 extern bool                      NSAddLibraryWithSearching(const char* pathName)      __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.4, "dlopen()");
 244 extern const struct mach_header* NSAddImage(const char* image_name, uint32_t options) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "dlopen()");
 245 #define NSADDIMAGE_OPTION_NONE                          0x0
 246 #define NSADDIMAGE_OPTION_RETURN_ON_ERROR               0x1
 247 #define NSADDIMAGE_OPTION_WITH_SEARCHING                0x2
 248 #define NSADDIMAGE_OPTION_RETURN_ONLY_IF_LOADED         0x4
 249 #define NSADDIMAGE_OPTION_MATCH_FILENAME_BY_INSTALLNAME 0x8
 250
 251 extern bool _dyld_present(void)                                                              __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "always true");
 252 extern bool _dyld_launched_prebound(void)                                                    __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "moot");
 253 extern bool _dyld_all_twolevel_modules_prebound(void)                                        __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.3, 10.5, "moot");
 254 extern bool _dyld_bind_fully_image_containing_address(const void* address)                   __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "dlopen(RTLD_NOW)");
 255 extern bool _dyld_image_containing_address(const void* address)                              __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.3, 10.5, "dladdr()");
 256 extern void _dyld_lookup_and_bind(const char* symbol_name, void **address, NSModule* module) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.4, "dlsym()");
 257 extern void _dyld_lookup_and_bind_with_hint(const char* symbol_name, const char* library_name_hint, void** address, NSModule* module) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.4, "dlsym()");
 258 extern void _dyld_lookup_and_bind_fully(const char* symbol_name, void** address, NSModule* module) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.1, 10.5, "dlsym()");
 259
 260 extern const struct mach_header*  _dyld_get_image_header_containing_address(const void* address) __IOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE __OSX_DEPRECATED(10.3, 10.5, "dladdr()");
 261
 262
 263 #if __cplusplus
 264 }
 265 #endif
 266
 267 #endif /* _MACH_O_DYLD_H_ */