projects / apple / dyld.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
dyld-733.6.tar.gz
[apple/dyld.git] / src / ImageLoader.h
1 /* -*- mode: C++; c-basic-offset: 4; tab-width: 4 -*-
2 *
3 * Copyright (c) 2004-2010 Apple Inc. All rights reserved.
4 *
5 * @APPLE_LICENSE_HEADER_START@
6 *
7 * This file contains Original Code and/or Modifications of Original Code
8 * as defined in and that are subject to the Apple Public Source License
9 * Version 2.0 (the 'License'). You may not use this file except in
10 * compliance with the License. Please obtain a copy of the License at
11 * http://www.opensource.apple.com/apsl/ and read it before using this
12 * file.
13 *
14 * The Original Code and all software distributed under the License are
15 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
16 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
17 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
19 * Please see the License for the specific language governing rights and
20 * limitations under the License.
21 *
22 * @APPLE_LICENSE_HEADER_END@
23 */
24
25
26 #ifndef __IMAGELOADER__
27 #define __IMAGELOADER__
28
29 #include <sys/types.h>
30 #include <unistd.h>
31 #include <stdlib.h>
32 #include <mach/mach_time.h> // struct mach_timebase_info
33 #include <mach/mach_init.h> // struct mach_thread_self
34 #include <mach/shared_region.h>
35 #include <mach-o/loader.h>
36 #include <mach-o/nlist.h>
37 #include <mach-o/dyld_images.h>
38 #include <mach-o/dyld_priv.h>
39 #include <stdint.h>
40 #include <stdlib.h>
41 #include <TargetConditionals.h>
42 #include <vector>
43 #include <new>
44 #include <uuid/uuid.h>
45
46 #if !TARGET_OS_DRIVERKIT && (BUILDING_LIBDYLD || BUILDING_DYLD)
47 #include <CrashReporterClient.h>
48 #else
49 #define CRSetCrashLogMessage(x)
50 #define CRSetCrashLogMessage2(x)
51 #endif
52
53 #include "DyldSharedCache.h"
54
55 #include "Map.h"
56
57 #if __arm__
58 #include <mach/vm_page_size.h>
59 #endif
60
61
62 #ifndef SHARED_REGION_BASE_ARM64
63 #define SHARED_REGION_BASE_ARM64 0x7FFF80000000LL
64 #endif
65
66 #ifndef SHARED_REGION_SIZE_ARM64
67 #define SHARED_REGION_SIZE_ARM64 0x10000000LL
68 #endif
69
70
71 #define LOG_BINDINGS 0
72
73
74 #if __IPHONE_OS_VERSION_MIN_REQUIRED
75 #define SPLIT_SEG_SHARED_REGION_SUPPORT 0
76 #define SPLIT_SEG_DYLIB_SUPPORT 0
77 #define PREBOUND_IMAGE_SUPPORT __arm__
78 #define TEXT_RELOC_SUPPORT __i386__
79 #define SUPPORT_OLD_CRT_INITIALIZATION 0
80 #define SUPPORT_LC_DYLD_ENVIRONMENT 1
81 #define SUPPORT_VERSIONED_PATHS 0
82 #define SUPPORT_CLASSIC_MACHO __arm__
83 #define SUPPORT_ZERO_COST_EXCEPTIONS (!__USING_SJLJ_EXCEPTIONS__)
84 #define INITIAL_IMAGE_COUNT 150
85 #define SUPPORT_ACCELERATE_TABLES !TARGET_OS_SIMULATOR
86 #define SUPPORT_ROOT_PATH TARGET_OS_SIMULATOR
87 #else
88 #define SPLIT_SEG_SHARED_REGION_SUPPORT 0
89 #define SPLIT_SEG_DYLIB_SUPPORT __i386__
90 #define PREBOUND_IMAGE_SUPPORT __i386__
91 #define TEXT_RELOC_SUPPORT __i386__
92 #define SUPPORT_OLD_CRT_INITIALIZATION __i386__
93 #define SUPPORT_LC_DYLD_ENVIRONMENT (__i386__ || __x86_64__)
94 #define SUPPORT_VERSIONED_PATHS 1
95 #define SUPPORT_CLASSIC_MACHO 1
96 #define SUPPORT_ZERO_COST_EXCEPTIONS 1
97 #define INITIAL_IMAGE_COUNT 200
98 #define SUPPORT_ACCELERATE_TABLES 0
99 #define SUPPORT_ROOT_PATH 1
100 #endif
101
102 #define MAX_MACH_O_HEADER_AND_LOAD_COMMANDS_SIZE (32*1024)
103
104
105 // <rdar://problem/13590567> optimize away dyld's initializers
106 #define VECTOR_NEVER_DESTRUCTED(type) \
107 namespace std { \
108 template <> \
109 __vector_base<type, std::allocator<type> >::~__vector_base() { } \
110 }
111 #define VECTOR_NEVER_DESTRUCTED_EXTERN(type) \
112 namespace std { \
113 template <> \
114 __vector_base<type, std::allocator<type> >::~__vector_base(); \
115 }
116 #define VECTOR_NEVER_DESTRUCTED_IMPL(type) \
117 namespace std { \
118 template <> \
119 __vector_base<type, std::allocator<type> >::~__vector_base() { } \
120 }
121
122 // utilities
123 namespace dyld {
124 extern __attribute__((noreturn)) void throwf(const char* format, ...) __attribute__((format(printf, 1, 2)));
125 extern void log(const char* format, ...) __attribute__((format(printf, 1, 2)));
126 extern void warn(const char* format, ...) __attribute__((format(printf, 1, 2)));
127 extern const char* mkstringf(const char* format, ...) __attribute__((format(printf, 1, 2)));
128 #if LOG_BINDINGS
129 extern void logBindings(const char* format, ...) __attribute__((format(printf, 1, 2)));
130 #endif
131 }
132 extern "C" int vm_alloc(vm_address_t* addr, vm_size_t size, uint32_t flags);
133 extern "C" void* xmmap(void* addr, size_t len, int prot, int flags, int fd, off_t offset);
134
135
136 #if __LP64__
137 struct macho_header : public mach_header_64 {};
138 struct macho_nlist : public nlist_64 {};
139 #else
140 struct macho_header : public mach_header {};
141 struct macho_nlist : public nlist {};
142 #endif
143
144
145 #if __arm64__
146 #define dyld_page_trunc(__addr) (__addr & (-16384))
147 #define dyld_page_round(__addr) ((__addr + 16383) & (-16384))
148 #define dyld_page_size 16384
149 #elif __arm__
150 #define dyld_page_trunc(__addr) trunc_page_kernel(__addr)
151 #define dyld_page_round(__addr) round_page_kernel(__addr)
152 #define dyld_page_size vm_kernel_page_size
153 #else
154 #define dyld_page_trunc(__addr) (__addr & (-4096))
155 #define dyld_page_round(__addr) ((__addr + 4095) & (-4096))
156 #define dyld_page_size 4096
157 #endif
158
159
160 #define DYLD_PACKED_VERSION(major, minor, tiny) ((((major) & 0xffff) << 16) | (((minor) & 0xff) << 8) | ((tiny) & 0xff))
161
162 struct ProgramVars
163 {
164 const void* mh;
165 int* NXArgcPtr;
166 const char*** NXArgvPtr;
167 const char*** environPtr;
168 const char** __prognamePtr;
169 };
170
171
172
173 enum dyld_image_states
174 {
175 dyld_image_state_mapped = 10, // No batch notification for this
176 dyld_image_state_dependents_mapped = 20, // Only batch notification for this
177 dyld_image_state_rebased = 30,
178 dyld_image_state_bound = 40,
179 dyld_image_state_dependents_initialized = 45, // Only single notification for this
180 dyld_image_state_initialized = 50,
181 dyld_image_state_terminated = 60 // Only single notification for this
182 };
183 typedef const char* (*dyld_image_state_change_handler)(enum dyld_image_states state, uint32_t infoCount, const struct dyld_image_info info[]);
184
185 //
186 // ImageLoader is an abstract base class. To support loading a particular executable
187 // file format, you make a concrete subclass of ImageLoader.
188 //
189 // For each executable file (dynamic shared object) in use, an ImageLoader is instantiated.
190 //
191 // The ImageLoader base class does the work of linking together images, but it knows nothing
192 // about any particular file format.
193 //
194 //
195 class ImageLoader {
196 public:
197
198 typedef uint32_t DefinitionFlags;
199 static const DefinitionFlags kNoDefinitionOptions = 0;
200 static const DefinitionFlags kWeakDefinition = 1;
201
202 typedef uint32_t ReferenceFlags;
203 static const ReferenceFlags kNoReferenceOptions = 0;
204 static const ReferenceFlags kWeakReference = 1;
205 static const ReferenceFlags kTentativeDefinition = 2;
206
207 enum PrebindMode { kUseAllPrebinding, kUseSplitSegPrebinding, kUseAllButAppPredbinding, kUseNoPrebinding };
208 enum BindingOptions { kBindingNone, kBindingLazyPointers, kBindingNeverSetLazyPointers };
209 enum SharedRegionMode { kUseSharedRegion, kUsePrivateSharedRegion, kDontUseSharedRegion, kSharedRegionIsSharedCache };
210
211 struct Symbol; // abstact symbol
212
213 struct MappedRegion {
214 uintptr_t address;
215 size_t size;
216 };
217
218 struct RPathChain {
219 RPathChain(const RPathChain* n, std::vector<const char*>* p) : next(n), paths(p) {};
220 const RPathChain* next;
221 std::vector<const char*>* paths;
222 };
223
224 struct DOFInfo {
225 void* dof;
226 const mach_header* imageHeader;
227 const char* imageShortName;
228 };
229
230 struct DynamicReference {
231 ImageLoader* from;
232 ImageLoader* to;
233 };
234
235 struct InitializerTimingList
236 {
237 uintptr_t count;
238 struct {
239 const char* shortName;
240 uint64_t initTime;
241 } images[1];
242
243 void addTime(const char* name, uint64_t time);
244 };
245
246 typedef void (^CoalesceNotifier)(const Symbol* implSym, const ImageLoader* implIn, const mach_header* implMh);
247
248 struct HashCString {
249 static size_t hash(const char* v);
250 };
251
252 struct EqualCString {
253 static bool equal(const char* s1, const char* s2);
254 };
255
256 struct LinkContext {
257 ImageLoader* (*loadLibrary)(const char* libraryName, bool search, const char* origin, const RPathChain* rpaths, unsigned& cacheIndex);
258 void (*terminationRecorder)(ImageLoader* image);
259 bool (*flatExportFinder)(const char* name, const Symbol** sym, const ImageLoader** image);
260 bool (*coalescedExportFinder)(const char* name, const Symbol** sym, const ImageLoader** image, CoalesceNotifier);
261 unsigned int (*getCoalescedImages)(ImageLoader* images[], unsigned imageIndex[]);
262 void (*undefinedHandler)(const char* name);
263 MappedRegion* (*getAllMappedRegions)(MappedRegion*);
264 void * (*bindingHandler)(const char *, const char *, void *);
265 void (*notifySingle)(dyld_image_states, const ImageLoader* image, InitializerTimingList*);
266 void (*notifyBatch)(dyld_image_states state, bool preflightOnly);
267 void (*removeImage)(ImageLoader* image);
268 void (*registerDOFs)(const std::vector<DOFInfo>& dofs);
269 void (*clearAllDepths)();
270 void (*printAllDepths)();
271 unsigned int (*imageCount)();
272 void (*setNewProgramVars)(const ProgramVars&);
273 bool (*inSharedCache)(const char* path);
274 void (*setErrorStrings)(unsigned errorCode, const char* errorClientOfDylibPath,
275 const char* errorTargetDylibPath, const char* errorSymbol);
276 ImageLoader* (*findImageContainingAddress)(const void* addr);
277 void (*addDynamicReference)(ImageLoader* from, ImageLoader* to);
278 #if SUPPORT_ACCELERATE_TABLES
279 void (*notifySingleFromCache)(dyld_image_states, const mach_header* mh, const char* path);
280 dyld_image_state_change_handler (*getPreInitNotifyHandler)(unsigned index);
281 dyld_image_state_change_handler (*getBoundBatchHandler)(unsigned index);
282 #endif
283
284 #if SUPPORT_OLD_CRT_INITIALIZATION
285 void (*setRunInitialzersOldWay)();
286 #endif
287 BindingOptions bindingOptions;
288 int argc;
289 const char** argv;
290 const char** envp;
291 const char** apple;
292 const char* progname;
293 ProgramVars programVars;
294 ImageLoader* mainExecutable;
295 const char* const * imageSuffix;
296 #if SUPPORT_ROOT_PATH
297 const char** rootPaths;
298 #endif
299 const DyldSharedCache* dyldCache;
300 const dyld_interpose_tuple* dynamicInterposeArray;
301 size_t dynamicInterposeCount;
302 PrebindMode prebindUsage;
303 SharedRegionMode sharedRegionMode;
304 mutable dyld3::Map<const char*, std::pair<const ImageLoader*, uintptr_t>, HashCString, EqualCString> weakDefMap;
305 mutable bool weakDefMapInitialized = false;
306 mutable bool weakDefMapProcessedLaunchDefs = false;
307 mutable bool useNewWeakBind = false;
308 bool dyldLoadedAtSameAddressNeededBySharedCache;
309 bool strictMachORequired;
310 bool allowAtPaths;
311 bool allowEnvVarsPrint;
312 bool allowEnvVarsPath;
313 bool allowEnvVarsSharedCache;
314 bool allowClassicFallbackPaths;
315 bool allowInsertFailures;
316 bool mainExecutableCodeSigned;
317 bool prebinding;
318 bool bindFlat;
319 bool linkingMainExecutable;
320 bool startedInitializingMainExecutable;
321 #if __MAC_OS_X_VERSION_MIN_REQUIRED
322 bool iOSonMac;
323 bool driverKit;
324 #endif
325 bool verboseOpts;
326 bool verboseEnv;
327 bool verboseLoading;
328 bool verboseMapping;
329 bool verboseRebase;
330 bool verboseBind;
331 bool verboseWeakBind;
332 bool verboseInit;
333 bool verboseDOF;
334 bool verbosePrebinding;
335 bool verboseCoreSymbolication;
336 bool verboseWarnings;
337 bool verboseRPaths;
338 bool verboseInterposing;
339 bool verboseCodeSignatures;
340 };
341
342 struct CoalIterator
343 {
344 ImageLoader* image;
345 const char* symbolName;
346 unsigned int loadOrder;
347 bool weakSymbol;
348 bool symbolMatches;
349 bool done;
350 // the following are private to the ImageLoader subclass
351 uintptr_t curIndex;
352 uintptr_t endIndex;
353 uintptr_t address;
354 uintptr_t type;
355 uintptr_t addend;
356 uintptr_t imageIndex;
357 };
358
359 virtual void initializeCoalIterator(CoalIterator&, unsigned int loadOrder, unsigned imageIndex) = 0;
360 virtual bool incrementCoalIterator(CoalIterator&) = 0;
361 virtual uintptr_t getAddressCoalIterator(CoalIterator&, const LinkContext& context) = 0;
362 virtual void updateUsesCoalIterator(CoalIterator&, uintptr_t newAddr, ImageLoader* target, unsigned targetIndex, const LinkContext& context) = 0;
363
364 struct UninitedUpwards
365 {
366 uintptr_t count;
367 std::pair<ImageLoader*, const char*> imagesAndPaths[1];
368 };
369
370
371 // constructor is protected, but anyone can delete an image
372 virtual ~ImageLoader();
373
374 // link() takes a newly instantiated ImageLoader and does all
375 // fixups needed to make it usable by the process
376 void link(const LinkContext& context, bool forceLazysBound, bool preflight, bool neverUnload, const RPathChain& loaderRPaths, const char* imagePath);
377
378 // runInitializers() is normally called in link() but the main executable must
379 // run crt code before initializers
380 void runInitializers(const LinkContext& context, InitializerTimingList& timingInfo);
381
382 // called after link() forces all lazy pointers to be bound
383 void bindAllLazyPointers(const LinkContext& context, bool recursive);
384
385 // used by dyld to see if a requested library is already loaded (might be symlink)
386 bool statMatch(const struct stat& stat_buf) const;
387
388 // get short name of this image
389 const char* getShortName() const;
390
391 // returns leaf name
392 static const char* shortName(const char* fullName);
393
394 // get path used to load this image, not necessarily the "real" path
395 const char* getPath() const { return fPath; }
396
397 uint32_t getPathHash() const { return fPathHash; }
398
399 // get the "real" path for this image (e.g. no @rpath)
400 const char* getRealPath() const;
401
402 // get path this image is intended to be placed on disk or NULL if no preferred install location
403 virtual const char* getInstallPath() const = 0;
404
405 // image was loaded with NSADDIMAGE_OPTION_MATCH_FILENAME_BY_INSTALLNAME and all clients are looking for install path
406 bool matchInstallPath() const;
407 void setMatchInstallPath(bool);
408
409 // mark that this image's exported symbols should be ignored when linking other images (e.g. RTLD_LOCAL)
410 void setHideExports(bool hide = true);
411
412 // check if this image's exported symbols should be ignored when linking other images
413 bool hasHiddenExports() const;
414
415 // checks if this image is already linked into the process
416 bool isLinked() const;
417
418 // even if image is deleted, leave segments mapped in
419 void setLeaveMapped();
420
421 // even if image is deleted, leave segments mapped in
422 bool leaveMapped() { return fLeaveMapped; }
423
424 // image resides in dyld shared cache
425 virtual bool inSharedCache() const { return false; };
426
427 // checks if the specifed address is within one of this image's segments
428 virtual bool containsAddress(const void* addr) const;
429
430 // checks if the specifed symbol is within this image's symbol table
431 virtual bool containsSymbol(const void* addr) const = 0;
432
433 // checks if the specifed address range overlaps any of this image's segments
434 virtual bool overlapsWithAddressRange(const void* start, const void* end) const;
435
436 // adds to list of ranges of memory mapped in
437 void getMappedRegions(MappedRegion*& region) const;
438
439 // st_mtime from stat() on file
440 time_t lastModified() const;
441
442 // only valid for main executables, returns a pointer its entry point from LC_MAIN
443 virtual void* getEntryFromLC_MAIN() const = 0;
444
445 // only valid for main executables, returns a pointer its main from LC_UNIXTHREAD
446 virtual void* getEntryFromLC_UNIXTHREAD() const = 0;
447
448 // dyld API's require each image to have an associated mach_header
449 virtual const struct mach_header* machHeader() const = 0;
450
451 // dyld API's require each image to have a slide (actual load address minus preferred load address)
452 virtual uintptr_t getSlide() const = 0;
453
454 // last address mapped by image
455 virtual const void* getEnd() const = 0;
456
457 // image has exports that participate in runtime coalescing
458 virtual bool hasCoalescedExports() const = 0;
459
460 // search symbol table of definitions in this image for requested name
461 virtual bool findExportedSymbolAddress(const LinkContext& context, const char* symbolName,
462 const ImageLoader* requestorImage, int requestorOrdinalOfDef,
463 bool runResolver, const ImageLoader** foundIn, uintptr_t* address) const;
464
465 // search symbol table of definitions in this image for requested name
466 virtual const Symbol* findExportedSymbol(const char* name, bool searchReExports, const char* thisPath, const ImageLoader** foundIn) const = 0;
467
468 // search symbol table of definitions in this image for requested name
469 virtual const Symbol* findExportedSymbol(const char* name, bool searchReExports, const ImageLoader** foundIn) const {
470 return findExportedSymbol(name, searchReExports, this->getPath(), foundIn);
471 }
472
473 // gets address of implementation (code) of the specified exported symbol
474 virtual uintptr_t getExportedSymbolAddress(const Symbol* sym, const LinkContext& context,
475 const ImageLoader* requestor=NULL, bool runResolver=false, const char* symbolName=NULL) const = 0;
476
477 // gets attributes of the specified exported symbol
478 virtual DefinitionFlags getExportedSymbolInfo(const Symbol* sym) const = 0;
479
480 // gets name of the specified exported symbol
481 virtual const char* getExportedSymbolName(const Symbol* sym) const = 0;
482
483 // gets how many symbols are exported by this image
484 virtual uint32_t getExportedSymbolCount() const = 0;
485
486 // gets the i'th exported symbol
487 virtual const Symbol* getIndexedExportedSymbol(uint32_t index) const = 0;
488
489 // find exported symbol as if imported by this image
490 // used by RTLD_NEXT
491 virtual const Symbol* findExportedSymbolInDependentImages(const char* name, const LinkContext& context, const ImageLoader** foundIn) const;
492
493 // find exported symbol as if imported by this image
494 // used by RTLD_SELF
495 virtual const Symbol* findExportedSymbolInImageOrDependentImages(const char* name, const LinkContext& context, const ImageLoader** foundIn) const;
496
497 // gets how many symbols are imported by this image
498 virtual uint32_t getImportedSymbolCount() const = 0;
499
500 // gets the i'th imported symbol
501 virtual const Symbol* getIndexedImportedSymbol(uint32_t index) const = 0;
502
503 // gets attributes of the specified imported symbol
504 virtual ReferenceFlags getImportedSymbolInfo(const Symbol* sym) const = 0;
505
506 // gets name of the specified imported symbol
507 virtual const char* getImportedSymbolName(const Symbol* sym) const = 0;
508
509 // find the closest symbol before addr
510 virtual const char* findClosestSymbol(const void* addr, const void** closestAddr) const = 0;
511
512 // for use with accelerator tables
513 virtual const char* getIndexedPath(unsigned) const { return getPath(); }
514 virtual const char* getIndexedShortName(unsigned) const { return getShortName(); }
515
516 // checks if this image is a bundle and can be loaded but not linked
517 virtual bool isBundle() const = 0;
518
519 // checks if this image is a dylib
520 virtual bool isDylib() const = 0;
521
522 // checks if this image is a main executable
523 virtual bool isExecutable() const = 0;
524
525 // checks if this image is a main executable
526 virtual bool isPositionIndependentExecutable() const = 0;
527
528 // only for main executable
529 virtual bool forceFlat() const = 0;
530
531 // called at runtime when a lazily bound function is first called
532 virtual uintptr_t doBindLazySymbol(uintptr_t* lazyPointer, const LinkContext& context) = 0;
533
534 // called at runtime when a fast lazily bound function is first called
535 virtual uintptr_t doBindFastLazySymbol(uint32_t lazyBindingInfoOffset, const LinkContext& context,
536 void (*lock)(), void (*unlock)()) = 0;
537
538 // calls termination routines (e.g. C++ static destructors for image)
539 virtual void doTermination(const LinkContext& context) = 0;
540
541 // return if this image has initialization routines
542 virtual bool needsInitialization() = 0;
543
544 // return if this image has specified section and set start and length
545 virtual bool getSectionContent(const char* segmentName, const char* sectionName, void** start, size_t* length) = 0;
546
547 // fills in info about __eh_frame and __unwind_info sections
548 virtual void getUnwindInfo(dyld_unwind_sections* info) = 0;
549
550 // given a pointer into an image, find which segment and section it is in
551 virtual const struct macho_section* findSection(const void* imageInterior) const = 0;
552
553 // given a pointer into an image, find which segment and section it is in
554 virtual bool findSection(const void* imageInterior, const char** segmentName, const char** sectionName, size_t* sectionOffset) = 0;
555
556 // the image supports being prebound
557 virtual bool isPrebindable() const = 0;
558
559 // the image is prebindable and its prebinding is valid
560 virtual bool usablePrebinding(const LinkContext& context) const = 0;
561
562 // add all RPATH paths this image contains
563 virtual void getRPaths(const LinkContext& context, std::vector<const char*>&) const = 0;
564
565 // image has or uses weak definitions that need runtime coalescing
566 virtual bool participatesInCoalescing() const = 0;
567
568 // if image has a UUID, copy into parameter and return true
569 virtual bool getUUID(uuid_t) const = 0;
570
571 // dynamic interpose values onto this image
572 virtual void dynamicInterpose(const LinkContext& context) = 0;
573
574 // record interposing for any late binding
575 void addDynamicInterposingTuples(const struct dyld_interpose_tuple array[], size_t count);
576
577 virtual const char* libPath(unsigned int) const = 0;
578
579 // Image has objc sections, so information objc about when it comes and goes
580 virtual bool notifyObjC() const { return false; }
581
582 virtual bool overridesCachedDylib(uint32_t& num) const { return false; }
583 virtual void setOverridesCachedDylib(uint32_t num) { }
584
585
586 //
587 // A segment is a chunk of an executable file that is mapped into memory.
588 //
589 virtual unsigned int segmentCount() const = 0;
590 virtual const char* segName(unsigned int) const = 0;
591 virtual uintptr_t segSize(unsigned int) const = 0;
592 virtual uintptr_t segFileSize(unsigned int) const = 0;
593 virtual bool segHasTrailingZeroFill(unsigned int) = 0;
594 virtual uintptr_t segFileOffset(unsigned int) const = 0;
595 virtual bool segReadable(unsigned int) const = 0;
596 virtual bool segWriteable(unsigned int) const = 0;
597 virtual bool segExecutable(unsigned int) const = 0;
598 virtual bool segUnaccessible(unsigned int) const = 0;
599 virtual bool segHasPreferredLoadAddress(unsigned int) const = 0;
600 virtual uintptr_t segPreferredLoadAddress(unsigned int) const = 0;
601 virtual uintptr_t segActualLoadAddress(unsigned int) const = 0;
602 virtual uintptr_t segActualEndAddress(unsigned int) const = 0;
603
604
605 // info from LC_VERSION_MIN_MACOSX or LC_VERSION_MIN_IPHONEOS
606 virtual uint32_t sdkVersion() const = 0;
607 virtual uint32_t minOSVersion() const = 0;
608
609 // if the image contains interposing functions, register them
610 virtual void registerInterposing(const LinkContext& context) = 0;
611
612 virtual bool usesChainedFixups() const { return false; }
613
614 virtual void makeDataReadOnly() const {}
615
616 // when resolving symbols look in subImage if symbol can't be found
617 void reExport(ImageLoader* subImage);
618
619 virtual void recursiveBind(const LinkContext& context, bool forceLazysBound, bool neverUnload);
620 void recursiveBindWithAccounting(const LinkContext& context, bool forceLazysBound, bool neverUnload);
621 void recursiveRebaseWithAccounting(const LinkContext& context);
622 void weakBind(const LinkContext& context);
623
624 void applyInterposing(const LinkContext& context);
625
626 dyld_image_states getState() { return (dyld_image_states)fState; }
627
628 ino_t getInode() const { return fInode; }
629 dev_t getDevice() const { return fDevice; }
630
631 // used to sort images bottom-up
632 int compare(const ImageLoader* right) const;
633
634 void incrementDlopenReferenceCount() { ++fDlopenReferenceCount; }
635
636 bool decrementDlopenReferenceCount();
637
638 void printReferenceCounts();
639
640 uint32_t dlopenCount() const { return fDlopenReferenceCount; }
641
642 void setCanUnload() { fNeverUnload = false; fLeaveMapped = false; }
643
644 bool neverUnload() const { return fNeverUnload; }
645
646 void setNeverUnload() { fNeverUnload = true; fLeaveMapped = true; }
647 void setNeverUnloadRecursive();
648
649 bool isReferencedDownward() { return fIsReferencedDownward; }
650
651 virtual void recursiveMakeDataReadOnly(const LinkContext& context);
652
653 virtual uintptr_t resolveWeak(const LinkContext& context, const char* symbolName, bool weak_import, bool runResolver,
654 const ImageLoader** foundIn) { return 0; }
655
656 // triggered by DYLD_PRINT_STATISTICS to write info on work done and how fast
657 static void printStatistics(unsigned int imageCount, const InitializerTimingList& timingInfo);
658 static void printStatisticsDetails(unsigned int imageCount, const InitializerTimingList& timingInfo);
659
660 // used with DYLD_IMAGE_SUFFIX
661 static void addSuffix(const char* path, const char* suffix, char* result);
662
663 static uint32_t hash(const char*);
664
665 static const uint8_t* trieWalk(const uint8_t* start, const uint8_t* end, const char* stringToFind);
666
667 // used instead of directly deleting image
668 static void deleteImage(ImageLoader*);
669
670 static bool haveInterposingTuples() { return !fgInterposingTuples.empty(); }
671 static void clearInterposingTuples() { fgInterposingTuples.clear(); }
672
673 static void applyInterposingToDyldCache(const LinkContext& context);
674
675 bool dependsOn(ImageLoader* image);
676
677 void setPath(const char* path);
678 void setPaths(const char* path, const char* realPath);
679 void setPathUnowned(const char* path);
680
681 void clearDepth() { fDepth = 0; }
682 int getDepth() { return fDepth; }
683
684 void setBeingRemoved() { fBeingRemoved = true; }
685 bool isBeingRemoved() const { return fBeingRemoved; }
686
687 void markNotUsed() { fMarkedInUse = false; }
688 void markedUsedRecursive(const std::vector<DynamicReference>&);
689 bool isMarkedInUse() const { return fMarkedInUse; }
690
691 void setAddFuncNotified() { fAddFuncNotified = true; }
692 bool addFuncNotified() const { return fAddFuncNotified; }
693
694 void setObjCMappedNotified() { fObjCMappedNotified = true; }
695 bool objCMappedNotified() const { return fObjCMappedNotified; }
696
697 struct InterposeTuple {
698 uintptr_t replacement;
699 ImageLoader* neverImage; // don't apply replacement to this image
700 ImageLoader* onlyImage; // only apply replacement to this image
701 uintptr_t replacee;
702 };
703
704 static uintptr_t read_uleb128(const uint8_t*& p, const uint8_t* end);
705 static intptr_t read_sleb128(const uint8_t*& p, const uint8_t* end);
706
707 void vmAccountingSetSuspended(const LinkContext& context, bool suspend);
708
709 protected:
710 // abstract base class so all constructors protected
711 ImageLoader(const char* path, unsigned int libCount);
712 ImageLoader(const ImageLoader&);
713 void operator=(const ImageLoader&);
714 void operator delete(void* image) throw() { ::free(image); }
715
716
717 struct LibraryInfo {
718 uint32_t checksum;
719 uint32_t minVersion;
720 uint32_t maxVersion;
721 };
722
723 struct DependentLibrary {
724 ImageLoader* image;
725 uint32_t required : 1,
726 checksumMatches : 1,
727 isReExported : 1,
728 isSubFramework : 1;
729 };
730
731 struct DependentLibraryInfo {
732 const char* name;
733 LibraryInfo info;
734 bool required;
735 bool reExported;
736 bool upward;
737 };
738
739
740 typedef void (*Initializer)(int argc, const char* argv[], const char* envp[], const char* apple[], const ProgramVars* vars);
741 typedef void (*Terminator)(void);
742
743
744
745 unsigned int libraryCount() const { return fLibraryCount; }
746 virtual ImageLoader* libImage(unsigned int) const = 0;
747 virtual bool libReExported(unsigned int) const = 0;
748 virtual bool libIsUpward(unsigned int) const = 0;
749 virtual void setLibImage(unsigned int, ImageLoader*, bool, bool) = 0;
750
751 // To link() an image, its dependent libraries are loaded, it is rebased, bound, and initialized.
752 // These methods do the above, exactly once, and it the right order
753 virtual void recursiveLoadLibraries(const LinkContext& context, bool preflightOnly, const RPathChain& loaderRPaths, const char* loadPath);
754 virtual unsigned recursiveUpdateDepth(unsigned int maxDepth);
755 virtual void recursiveRebase(const LinkContext& context);
756 virtual void recursiveApplyInterposing(const LinkContext& context);
757 virtual void recursiveGetDOFSections(const LinkContext& context, std::vector<DOFInfo>& dofs);
758 virtual void recursiveInitialization(const LinkContext& context, mach_port_t this_thread, const char* pathToInitialize,
759 ImageLoader::InitializerTimingList&, ImageLoader::UninitedUpwards&);
760
761 // fill in information about dependent libraries (array length is fLibraryCount)
762 virtual void doGetDependentLibraries(DependentLibraryInfo libs[]) = 0;
763
764 // called on images that are libraries, returns info about itself
765 virtual LibraryInfo doGetLibraryInfo(const LibraryInfo& requestorInfo) = 0;
766
767 // do any fix ups in this image that depend only on the load address of the image
768 virtual void doRebase(const LinkContext& context) = 0;
769
770 // do any symbolic fix ups in this image
771 virtual void doBind(const LinkContext& context, bool forceLazysBound) = 0;
772
773 // called later via API to force all lazy pointer to be bound
774 virtual void doBindJustLazies(const LinkContext& context) = 0;
775
776 // if image has any dtrace DOF sections, append them to list to be registered
777 virtual void doGetDOFSections(const LinkContext& context, std::vector<DOFInfo>& dofs) = 0;
778
779 // do interpose
780 virtual void doInterpose(const LinkContext& context) = 0;
781
782 // run any initialization routines in this image
783 virtual bool doInitialization(const LinkContext& context) = 0;
784
785 // return if this image has termination routines
786 virtual bool needsTermination() = 0;
787
788 // support for runtimes in which segments don't have to maintain their relative positions
789 virtual bool segmentsMustSlideTogether() const = 0;
790
791 // built with PIC code and can load at any address
792 virtual bool segmentsCanSlide() const = 0;
793
794 // set how much all segments slide
795 virtual void setSlide(intptr_t slide) = 0;
796
797 // returns if all dependent libraries checksum's were as expected and none slide
798 bool allDependentLibrariesAsWhenPreBound() const;
799
800 // in mach-o a child tells it parent to re-export, instead of the other way around...
801 virtual bool isSubframeworkOf(const LinkContext& context, const ImageLoader* image) const = 0;
802
803 // in mach-o a parent library knows name of sub libraries it re-exports..
804 virtual bool hasSubLibrary(const LinkContext& context, const ImageLoader* child) const = 0;
805
806 virtual bool weakSymbolsBound(unsigned index) const { return fWeakSymbolsBound; }
807 virtual void setWeakSymbolsBound(unsigned index) { fWeakSymbolsBound = true; }
808
809 // set fState to dyld_image_state_memory_mapped
810 void setMapped(const LinkContext& context);
811
812 void setFileInfo(dev_t device, ino_t inode, time_t modDate);
813
814 void setDepth(uint16_t depth) { fDepth = depth; }
815
816 static uintptr_t interposedAddress(const LinkContext& context, uintptr_t address, const ImageLoader* notInImage, const ImageLoader* onlyInImage=NULL);
817
818 static uintptr_t fgNextPIEDylibAddress;
819 static uint32_t fgImagesWithUsedPrebinding;
820 static uint32_t fgImagesUsedFromSharedCache;
821 static uint32_t fgImagesHasWeakDefinitions;
822 static uint32_t fgImagesRequiringCoalescing;
823 static uint32_t fgTotalRebaseFixups;
824 static uint32_t fgTotalBindFixups;
825 static uint32_t fgTotalBindSymbolsResolved;
826 static uint32_t fgTotalBindImageSearches;
827 static uint32_t fgTotalLazyBindFixups;
828 static uint32_t fgTotalPossibleLazyBindFixups;
829 static uint32_t fgTotalSegmentsMapped;
830 static uint32_t fgSymbolTrieSearchs;
831 static uint64_t fgTotalBytesMapped;
832 static uint64_t fgTotalLoadLibrariesTime;
833 public:
834 static uint64_t fgTotalObjCSetupTime;
835 static uint64_t fgTotalDebuggerPausedTime;
836 static uint64_t fgTotalRebindCacheTime;
837 static uint64_t fgTotalRebaseTime;
838 static uint64_t fgTotalBindTime;
839 static uint64_t fgTotalWeakBindTime;
840 static uint64_t fgTotalDOF;
841 static uint64_t fgTotalInitTime;
842
843 protected:
844 static std::vector<InterposeTuple> fgInterposingTuples;
845
846 const char* fPath;
847 const char* fRealPath;
848 dev_t fDevice;
849 ino_t fInode;
850 time_t fLastModified;
851 uint32_t fPathHash;
852 uint32_t fDlopenReferenceCount; // count of how many dlopens have been done on this image
853
854 struct recursive_lock {
855 recursive_lock(mach_port_t t) : thread(t), count(0) {}
856 mach_port_t thread;
857 int count;
858 };
859 void recursiveSpinLock(recursive_lock&);
860 void recursiveSpinUnLock();
861
862 private:
863 const ImageLoader::Symbol* findExportedSymbolInDependentImagesExcept(const char* name, const ImageLoader** dsiStart,
864 const ImageLoader**& dsiCur, const ImageLoader** dsiEnd, const ImageLoader** foundIn) const;
865
866 void processInitializers(const LinkContext& context, mach_port_t this_thread,
867 InitializerTimingList& timingInfo, ImageLoader::UninitedUpwards& ups);
868
869 void weakBindOld(const LinkContext& context);
870
871
872 recursive_lock* fInitializerRecursiveLock;
873 union {
874 struct {
875 uint16_t fLoadOrder;
876 uint16_t fDepth : 15,
877 fObjCMappedNotified : 1;
878 uint32_t fState : 8,
879 fLibraryCount : 9,
880 fMadeReadOnly : 1,
881 fAllLibraryChecksumsAndLoadAddressesMatch : 1,
882 fLeaveMapped : 1, // when unloaded, leave image mapped in cause some other code may have pointers into it
883 fNeverUnload : 1, // image was statically loaded by main executable
884 fHideSymbols : 1, // ignore this image's exported symbols when linking other images
885 fMatchByInstallName : 1,// look at image's install-path not its load path
886 fInterposed : 1,
887 fRegisteredDOF : 1,
888 fAllLazyPointersBound : 1,
889 fMarkedInUse : 1,
890 fBeingRemoved : 1,
891 fAddFuncNotified : 1,
892 fPathOwnedByImage : 1,
893 fIsReferencedDownward : 1,
894 fWeakSymbolsBound : 1;
895 };
896 uint64_t sizeOfData;
897 };
898 static_assert(sizeof(sizeOfData) == 8, "Bad data size");
899
900 static uint16_t fgLoadOrdinal;
901 };
902
903
904 VECTOR_NEVER_DESTRUCTED_EXTERN(ImageLoader::InterposeTuple);
905
906
907 #endif
908
mirror of dyld