2 * Copyright (c) 2017 Apple Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
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
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.
21 * @APPLE_LICENSE_HEADER_END@
26 #ifndef __DYLD_APIS_H__
27 #define __DYLD_APIS_H__
32 #include <uuid/uuid.h>
35 #include "dyld_priv.h"
38 #define TEMP_HIDDEN __attribute__((visibility("hidden")))
41 // The implementation of all dyld load/unload API's must hold a global lock
42 // so that the next load/unload does start until the current is complete.
43 // This lock is recursive so that initializers can call dlopen().
44 // This is done using the macros DYLD_LOCK_THIS_BLOCK.
47 // void dyld_load_api() {
48 // DYLD_LOAD_LOCK_THIS_BLOCK;
49 // // free to do stuff here
50 // // that accesses dyld internal data structures
55 #define DYLD_LOAD_LOCK_THIS_BLOCK RecursiveAutoLock _dyld_load_lock;
59 class __attribute__((visibility("hidden"))) RecursiveAutoLock
63 pthread_mutex_lock(&_sMutex
);
65 ~RecursiveAutoLock() {
66 pthread_mutex_unlock(&_sMutex
);
69 static pthread_mutex_t _sMutex
;
75 uint32_t _dyld_image_count() TEMP_HIDDEN
;
77 const mach_header
* _dyld_get_image_header(uint32_t imageIndex
) TEMP_HIDDEN
;
79 intptr_t _dyld_get_image_slide(const mach_header
* mh
) TEMP_HIDDEN
;
81 intptr_t _dyld_get_image_vmaddr_slide(uint32_t imageIndex
) TEMP_HIDDEN
;
83 const char* _dyld_get_image_name(uint32_t imageIndex
) TEMP_HIDDEN
;
85 int32_t NSVersionOfLinkTimeLibrary(const char* libraryName
) TEMP_HIDDEN
;
87 int32_t NSVersionOfRunTimeLibrary(const char* libraryName
) TEMP_HIDDEN
;
89 uint32_t dyld_get_program_sdk_watch_os_version() TEMP_HIDDEN
;
90 uint32_t dyld_get_program_min_watch_os_version() TEMP_HIDDEN
;
92 uint32_t dyld_get_program_sdk_bridge_os_version() TEMP_HIDDEN
;
93 uint32_t dyld_get_program_min_bridge_os_version() TEMP_HIDDEN
;
96 uint32_t dyld_get_sdk_version(const mach_header
* mh
) TEMP_HIDDEN
;
99 uint32_t dyld_get_program_sdk_version() TEMP_HIDDEN
;
100 uint32_t dyld_get_min_os_version(const mach_header
* mh
) TEMP_HIDDEN
;
102 uint32_t dyld_get_program_min_os_version() TEMP_HIDDEN
;
104 dyld_platform_t
dyld_get_active_platform(void) TEMP_HIDDEN
;
105 dyld_platform_t
dyld_get_base_platform(dyld_platform_t platform
) TEMP_HIDDEN
;
106 bool dyld_is_simulator_platform(dyld_platform_t platform
) TEMP_HIDDEN
;
107 bool dyld_sdk_at_least(const struct mach_header
* mh
, dyld_build_version_t version
) TEMP_HIDDEN
;
108 bool dyld_minos_at_least(const struct mach_header
* mh
, dyld_build_version_t version
) TEMP_HIDDEN
;
109 bool dyld_program_sdk_at_least(dyld_build_version_t version
) TEMP_HIDDEN
;
110 bool dyld_program_minos_at_least(dyld_build_version_t version
) TEMP_HIDDEN
;
111 void dyld_get_image_versions(const struct mach_header
* mh
, void (^callback
)(dyld_platform_t platform
, uint32_t sdk_version
, uint32_t min_version
)) TEMP_HIDDEN
;
113 bool _dyld_get_image_uuid(const mach_header
* mh
, uuid_t uuid
) TEMP_HIDDEN
;
115 int _NSGetExecutablePath(char* buf
, uint32_t* bufsize
) TEMP_HIDDEN
;
117 void _dyld_register_func_for_add_image(void (*func
)(const mach_header
*mh
, intptr_t vmaddr_slide
)) TEMP_HIDDEN
;
119 void _dyld_register_func_for_remove_image(void (*func
)(const mach_header
*mh
, intptr_t vmaddr_slide
)) TEMP_HIDDEN
;
121 void _dyld_objc_notify_register(_dyld_objc_notify_mapped mapped
,
122 _dyld_objc_notify_init init
,
123 _dyld_objc_notify_unmapped unmapped
) TEMP_HIDDEN
;
125 const mach_header
* dyld_image_header_containing_address(const void* addr
) TEMP_HIDDEN
;
127 const mach_header
* _dyld_get_image_header_containing_address(const void* address
) TEMP_HIDDEN
;
129 bool _dyld_image_containing_address(const void* address
) TEMP_HIDDEN
;
131 const char* dyld_image_path_containing_address(const void* addr
) TEMP_HIDDEN
;
133 bool _dyld_is_memory_immutable(const void* addr
, size_t length
) TEMP_HIDDEN
;
136 int dladdr(const void* addr
, Dl_info
* info
) TEMP_HIDDEN
;
138 char* dlerror() TEMP_HIDDEN
;
140 int dlclose(void* handle
) TEMP_HIDDEN
;
142 void* dlopen_internal(const char* path
, int mode
, void* callerAddress
) TEMP_HIDDEN
;
144 bool dlopen_preflight_internal(const char* path
) TEMP_HIDDEN
;
146 void* dlsym_internal(void* handle
, const char* symbolName
, void* callerAddress
) TEMP_HIDDEN
;
148 const struct dyld_all_image_infos
* _dyld_get_all_image_infos() TEMP_HIDDEN
;
150 bool dyld_shared_cache_some_image_overridden() TEMP_HIDDEN
;
152 bool _dyld_get_shared_cache_uuid(uuid_t uuid
) TEMP_HIDDEN
;
154 const void* _dyld_get_shared_cache_range(size_t* length
) TEMP_HIDDEN
;
156 void _dyld_images_for_addresses(unsigned count
, const void* addresses
[], struct dyld_image_uuid_offset infos
[]) TEMP_HIDDEN
;
158 void _dyld_register_for_image_loads(void (*func
)(const mach_header
* mh
, const char* path
, bool unloadable
)) TEMP_HIDDEN
;
160 bool _dyld_find_unwind_sections(void* addr
, dyld_unwind_sections
* info
) TEMP_HIDDEN
;
162 bool dyld_process_is_restricted() TEMP_HIDDEN
;
164 const char* dyld_shared_cache_file_path() TEMP_HIDDEN
;
166 void dyld_dynamic_interpose(const mach_header
* mh
, const dyld_interpose_tuple array
[], size_t count
) TEMP_HIDDEN
;
168 int dyld_shared_cache_find_iterate_text(const uuid_t cacheUuid
, const char* extraSearchDirs
[], void (^callback
)(const dyld_shared_cache_dylib_text_info
* info
)) TEMP_HIDDEN
;
170 int dyld_shared_cache_iterate_text(const uuid_t cacheUuid
, void (^callback
)(const dyld_shared_cache_dylib_text_info
* info
)) TEMP_HIDDEN
;
172 void _dyld_fork_child() TEMP_HIDDEN
;
174 // only in macOS and deprecated
175 #if __MAC_OS_X_VERSION_MIN_REQUIRED
176 NSObjectFileImageReturnCode
NSCreateObjectFileImageFromFile(const char* pathName
, NSObjectFileImage
*objectFileImage
) TEMP_HIDDEN
;
177 NSObjectFileImageReturnCode
NSCreateObjectFileImageFromMemory(const void *address
, size_t size
, NSObjectFileImage
*objectFileImage
) TEMP_HIDDEN
;
178 bool NSDestroyObjectFileImage(NSObjectFileImage objectFileImage
) TEMP_HIDDEN
;
179 uint32_t NSSymbolDefinitionCountInObjectFileImage(NSObjectFileImage objectFileImage
) TEMP_HIDDEN
;
180 const char* NSSymbolDefinitionNameInObjectFileImage(NSObjectFileImage objectFileImage
, uint32_t ordinal
) TEMP_HIDDEN
;
181 uint32_t NSSymbolReferenceCountInObjectFileImage(NSObjectFileImage objectFileImage
) TEMP_HIDDEN
;
182 const char* NSSymbolReferenceNameInObjectFileImage(NSObjectFileImage objectFileImage
, uint32_t ordinal
, bool *tentative_definition
) TEMP_HIDDEN
;
183 bool NSIsSymbolDefinedInObjectFileImage(NSObjectFileImage objectFileImage
, const char* symbolName
) TEMP_HIDDEN
;
184 void* NSGetSectionDataInObjectFileImage(NSObjectFileImage objectFileImage
, const char* segmentName
, const char* sectionName
, size_t *size
) TEMP_HIDDEN
;
185 const char* NSNameOfModule(NSModule m
) TEMP_HIDDEN
;
186 const char* NSLibraryNameForModule(NSModule m
) TEMP_HIDDEN
;
187 NSModule
NSLinkModule(NSObjectFileImage objectFileImage
, const char* moduleName
, uint32_t options
) TEMP_HIDDEN
;
188 bool NSUnLinkModule(NSModule module
, uint32_t options
) TEMP_HIDDEN
;
189 bool NSIsSymbolNameDefined(const char* symbolName
) TEMP_HIDDEN
;
190 bool NSIsSymbolNameDefinedWithHint(const char* symbolName
, const char* libraryNameHint
) TEMP_HIDDEN
;
191 bool NSIsSymbolNameDefinedInImage(const struct mach_header
* image
, const char* symbolName
) TEMP_HIDDEN
;
192 NSSymbol
NSLookupAndBindSymbol(const char* symbolName
) TEMP_HIDDEN
;
193 NSSymbol
NSLookupAndBindSymbolWithHint(const char* symbolName
, const char* libraryNameHint
) TEMP_HIDDEN
;
194 NSSymbol
NSLookupSymbolInModule(NSModule module
, const char* symbolName
) TEMP_HIDDEN
;
195 NSSymbol
NSLookupSymbolInImage(const struct mach_header
* image
, const char* symbolName
, uint32_t options
) TEMP_HIDDEN
;
196 const char* NSNameOfSymbol(NSSymbol symbol
) TEMP_HIDDEN
;
197 void* NSAddressOfSymbol(NSSymbol symbol
) TEMP_HIDDEN
;
198 NSModule
NSModuleForSymbol(NSSymbol symbol
) TEMP_HIDDEN
;
199 void NSLinkEditError(NSLinkEditErrors
*c
, int *errorNumber
, const char** fileName
, const char** errorString
) TEMP_HIDDEN
;
200 bool NSAddLibrary(const char* pathName
) TEMP_HIDDEN
;
201 bool NSAddLibraryWithSearching(const char* pathName
) TEMP_HIDDEN
;
202 const struct mach_header
* NSAddImage(const char* image_name
, uint32_t options
) TEMP_HIDDEN
;
203 void NSInstallLinkEditErrorHandlers(const NSLinkEditErrorHandlers
*handlers
) TEMP_HIDDEN
;
204 bool _dyld_present(void) TEMP_HIDDEN
;
205 bool _dyld_launched_prebound(void) TEMP_HIDDEN
;
206 bool _dyld_all_twolevel_modules_prebound(void) TEMP_HIDDEN
;
207 bool _dyld_bind_fully_image_containing_address(const void* address
) TEMP_HIDDEN
;
208 bool _dyld_image_containing_address(const void* address
) TEMP_HIDDEN
;
209 void _dyld_lookup_and_bind(const char* symbol_name
, void **address
, NSModule
* module
) TEMP_HIDDEN
;
210 void _dyld_lookup_and_bind_with_hint(const char* symbol_name
, const char* library_name_hint
, void** address
, NSModule
* module
) TEMP_HIDDEN
;
211 void _dyld_lookup_and_bind_fully(const char* symbol_name
, void** address
, NSModule
* module
) TEMP_HIDDEN
;
212 const struct mach_header
* _dyld_get_image_header_containing_address(const void* address
) TEMP_HIDDEN
;
217 #endif // __DYLD_APIS_H__