/
MachOFile.cpp
1951 lines (1760 loc) · 70.3 KB
/
MachOFile.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2017 Apple Inc. All rights reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
#include <stdlib.h>
#include <assert.h>
#include <string.h>
#include <stdio.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <sys/errno.h>
#include <sys/fcntl.h>
#include <unistd.h>
#include <TargetConditionals.h>
#include <mach/host_info.h>
#include <mach/mach.h>
#include <mach/mach_host.h>
#include "Array.h"
#include "MachOFile.h"
#include "SupportedArchs.h"
#if BUILDING_DYLD || BUILDING_LIBDYLD
// define away restrict until rdar://60166935 is fixed
#define restrict
#include <subsystem.h>
#endif
namespace dyld3 {
//////////////////////////// posix wrappers ////////////////////////////////////////
// <rdar://problem/10111032> wrap calls to stat() with check for EAGAIN
int stat(const char* path, struct stat* buf)
{
int result;
do {
#if BUILDING_DYLD
result = ::stat_with_subsystem(path, buf);
#else
result = ::stat(path, buf);
#endif
} while ((result == -1) && ((errno == EAGAIN) || (errno == EINTR)));
return result;
}
// <rdar://problem/13805025> dyld should retry open() if it gets an EGAIN
int open(const char* path, int flag, int other)
{
int result;
do {
#if BUILDING_DYLD
if (flag & O_CREAT)
result = ::open(path, flag, other);
else
result = ::open_with_subsystem(path, flag);
#else
result = ::open(path, flag, other);
#endif
} while ((result == -1) && ((errno == EAGAIN) || (errno == EINTR)));
return result;
}
//////////////////////////// FatFile ////////////////////////////////////////
const FatFile* FatFile::isFatFile(const void* fileStart)
{
const FatFile* fileStartAsFat = (FatFile*)fileStart;
if ( (fileStartAsFat->magic == OSSwapBigToHostInt32(FAT_MAGIC)) || (fileStartAsFat->magic == OSSwapBigToHostInt32(FAT_MAGIC_64)) )
return fileStartAsFat;
else
return nullptr;
}
bool FatFile::isValidSlice(Diagnostics& diag, uint64_t fileLen, uint32_t sliceIndex,
uint32_t sliceCpuType, uint32_t sliceCpuSubType, uint64_t sliceOffset, uint64_t sliceLen) const {
if ( greaterThanAddOrOverflow(sliceOffset, sliceLen, fileLen) ) {
diag.error("slice %d extends beyond end of file", sliceIndex);
return false;
}
const dyld3::MachOFile* mf = (const dyld3::MachOFile*)((uint8_t*)this+sliceOffset);
if (!mf->isMachO(diag, sliceLen))
return false;
if ( mf->cputype != (cpu_type_t)sliceCpuType ) {
diag.error("cpu type in slice (0x%08X) does not match fat header (0x%08X)", mf->cputype, sliceCpuType);
return false;
}
else if ( (mf->cpusubtype & ~CPU_SUBTYPE_MASK) != (sliceCpuSubType & ~CPU_SUBTYPE_MASK) ) {
diag.error("cpu subtype in slice (0x%08X) does not match fat header (0x%08X)", mf->cpusubtype, sliceCpuSubType);
return false;
}
uint32_t pageSizeMask = mf->uses16KPages() ? 0x3FFF : 0xFFF;
if ( (sliceOffset & pageSizeMask) != 0 ) {
// slice not page aligned
if ( strncmp((char*)this+sliceOffset, "!<arch>", 7) == 0 )
diag.error("file is static library");
else
diag.error("slice is not page aligned");
return false;
}
return true;
}
void FatFile::forEachSlice(Diagnostics& diag, uint64_t fileLen, bool validate,
void (^callback)(uint32_t sliceCpuType, uint32_t sliceCpuSubType, const void* sliceStart, uint64_t sliceSize, bool& stop)) const
{
if ( this->magic == OSSwapBigToHostInt32(FAT_MAGIC) ) {
const uint64_t maxArchs = ((4096 - sizeof(fat_header)) / sizeof(fat_arch));
const uint32_t numArchs = OSSwapBigToHostInt32(nfat_arch);
if ( numArchs > maxArchs ) {
diag.error("fat header too large: %u entries", numArchs);
return;
}
bool stop = false;
const fat_arch* const archs = (fat_arch*)(((char*)this)+sizeof(fat_header));
for (uint32_t i=0; i < numArchs; ++i) {
uint32_t cpuType = OSSwapBigToHostInt32(archs[i].cputype);
uint32_t cpuSubType = OSSwapBigToHostInt32(archs[i].cpusubtype);
uint32_t offset = OSSwapBigToHostInt32(archs[i].offset);
uint32_t len = OSSwapBigToHostInt32(archs[i].size);
Diagnostics sliceDiag;
if ( !validate || isValidSlice(sliceDiag, fileLen, i, cpuType, cpuSubType, offset, len) )
callback(cpuType, cpuSubType, (uint8_t*)this+offset, len, stop);
if ( stop )
break;
if ( sliceDiag.hasError() )
diag.appendError("%s, ", sliceDiag.errorMessageCStr());
}
// Look for one more slice
if ( numArchs != maxArchs ) {
uint32_t cpuType = OSSwapBigToHostInt32(archs[numArchs].cputype);
uint32_t cpuSubType = OSSwapBigToHostInt32(archs[numArchs].cpusubtype);
uint32_t offset = OSSwapBigToHostInt32(archs[numArchs].offset);
uint32_t len = OSSwapBigToHostInt32(archs[numArchs].size);
if ((cpuType == CPU_TYPE_ARM64) && ((cpuSubType == CPU_SUBTYPE_ARM64_ALL || cpuSubType == CPU_SUBTYPE_ARM64_V8))) {
if ( !validate || isValidSlice(diag, fileLen, numArchs, cpuType, cpuSubType, offset, len) )
callback(cpuType, cpuSubType, (uint8_t*)this+offset, len, stop);
}
}
}
else if ( this->magic == OSSwapBigToHostInt32(FAT_MAGIC_64) ) {
if ( OSSwapBigToHostInt32(nfat_arch) > ((4096 - sizeof(fat_header)) / sizeof(fat_arch)) ) {
diag.error("fat header too large: %u entries", OSSwapBigToHostInt32(nfat_arch));
return;
}
bool stop = false;
const fat_arch_64* const archs = (fat_arch_64*)(((char*)this)+sizeof(fat_header));
for (uint32_t i=0; i < OSSwapBigToHostInt32(nfat_arch); ++i) {
uint32_t cpuType = OSSwapBigToHostInt32(archs[i].cputype);
uint32_t cpuSubType = OSSwapBigToHostInt32(archs[i].cpusubtype);
uint64_t offset = OSSwapBigToHostInt64(archs[i].offset);
uint64_t len = OSSwapBigToHostInt64(archs[i].size);
if ( !validate || isValidSlice(diag, fileLen, i, cpuType, cpuSubType, offset, len) )
callback(cpuType, cpuSubType, (uint8_t*)this+offset, len, stop);
if ( stop )
break;
}
}
else {
diag.error("not a fat file");
}
}
void FatFile::forEachSlice(Diagnostics& diag, uint64_t fileLen, void (^callback)(uint32_t sliceCpuType, uint32_t sliceCpuSubType, const void* sliceStart, uint64_t sliceSize, bool& stop)) const
{
forEachSlice(diag, fileLen, true, callback);
}
const char* FatFile::archNames(char strBuf[256]) const
{
strBuf[0] = '\0';
Diagnostics diag;
__block bool needComma = false;
this->forEachSlice(diag, 0xFFFFFFFF, false, ^(uint32_t sliceCpuType, uint32_t sliceCpuSubType, const void* sliceStart, uint64_t sliceSize, bool& stop) {
if ( needComma )
strlcat(strBuf, ",", 256);
strlcat(strBuf, MachOFile::archName(sliceCpuType, sliceCpuSubType), 256);
needComma = true;
});
return strBuf;
}
bool FatFile::isFatFileWithSlice(Diagnostics& diag, uint64_t fileLen, const GradedArchs& archs, bool isOSBinary,
uint64_t& sliceOffset, uint64_t& sliceLen, bool& missingSlice) const
{
missingSlice = false;
if ( (this->magic != OSSwapBigToHostInt32(FAT_MAGIC)) && (this->magic != OSSwapBigToHostInt32(FAT_MAGIC_64)) )
return false;
__block int bestGrade = 0;
forEachSlice(diag, fileLen, ^(uint32_t sliceCpuType, uint32_t sliceCpuSubType, const void* sliceStart, uint64_t sliceSize, bool& stop) {
if (int sliceGrade = archs.grade(sliceCpuType, sliceCpuSubType, isOSBinary)) {
if ( sliceGrade > bestGrade ) {
sliceOffset = (char*)sliceStart - (char*)this;
sliceLen = sliceSize;
bestGrade = sliceGrade;
}
}
});
if ( diag.hasError() )
return false;
if ( bestGrade == 0 )
missingSlice = true;
return (bestGrade != 0);
}
//////////////////////////// GradedArchs ////////////////////////////////////////
#define GRADE_i386 CPU_TYPE_I386, CPU_SUBTYPE_I386_ALL, false
#define GRADE_x86_64 CPU_TYPE_X86_64, CPU_SUBTYPE_X86_64_ALL, false
#define GRADE_x86_64h CPU_TYPE_X86_64, CPU_SUBTYPE_X86_64_H, false
#define GRADE_armv7 CPU_TYPE_ARM, CPU_SUBTYPE_ARM_V7, false
#define GRADE_armv7s CPU_TYPE_ARM, CPU_SUBTYPE_ARM_V7S, false
#define GRADE_armv7k CPU_TYPE_ARM, CPU_SUBTYPE_ARM_V7K, false
#define GRADE_arm64 CPU_TYPE_ARM64, CPU_SUBTYPE_ARM64_ALL, false
#define GRADE_arm64e CPU_TYPE_ARM64, CPU_SUBTYPE_ARM64E, false
#define GRADE_arm64e_pb CPU_TYPE_ARM64, CPU_SUBTYPE_ARM64E, true
#define GRADE_arm64_32 CPU_TYPE_ARM64_32, CPU_SUBTYPE_ARM64_32_V8, false
const GradedArchs GradedArchs::i386 = { {{GRADE_i386, 1}} };
const GradedArchs GradedArchs::x86_64 = { {{GRADE_x86_64, 1}} };
const GradedArchs GradedArchs::x86_64h = { {{GRADE_x86_64h, 2}, {GRADE_x86_64, 1}} };
const GradedArchs GradedArchs::arm64 = { {{GRADE_arm64, 1}} };
#if SUPPORT_ARCH_arm64e
const GradedArchs GradedArchs::arm64e_keysoff = { {{GRADE_arm64e, 2}, {GRADE_arm64, 1}} };
const GradedArchs GradedArchs::arm64e_keysoff_pb = { {{GRADE_arm64e_pb, 2}, {GRADE_arm64, 1}} };
const GradedArchs GradedArchs::arm64e = { {{GRADE_arm64e, 1}} };
const GradedArchs GradedArchs::arm64e_pb = { {{GRADE_arm64e_pb, 1}} };
#endif
const GradedArchs GradedArchs::armv7 = { {{GRADE_armv7, 1}} };
const GradedArchs GradedArchs::armv7s = { {{GRADE_armv7s, 2}, {GRADE_armv7, 1}} };
const GradedArchs GradedArchs::armv7k = { {{GRADE_armv7k, 1}} };
#if SUPPORT_ARCH_arm64_32
const GradedArchs GradedArchs::arm64_32 = { {{GRADE_arm64_32, 1}} };
#endif
int GradedArchs::grade(uint32_t cputype, uint32_t cpusubtype, bool isOSBinary) const
{
for (const CpuGrade* p = _orderedCpuTypes; p->type != 0; ++p) {
if ( (p->type == cputype) && (p->subtype == (cpusubtype & ~CPU_SUBTYPE_MASK)) ) {
if ( p->osBinary ) {
if ( isOSBinary )
return p->grade;
}
else {
return p->grade;
}
}
}
return 0;
}
const char* GradedArchs::name() const
{
return MachOFile::archName(_orderedCpuTypes[0].type, _orderedCpuTypes[0].subtype);
}
bool GradedArchs::checksOSBinary() const
{
for (const CpuGrade* p = _orderedCpuTypes; p->type != 0; ++p) {
if ( p->osBinary )
return true;
}
return false;
}
#if __x86_64__
static bool isHaswell()
{
// FIXME: figure out a commpage way to check this
struct host_basic_info info;
mach_msg_type_number_t count = HOST_BASIC_INFO_COUNT;
mach_port_t hostPort = mach_host_self();
kern_return_t result = host_info(hostPort, HOST_BASIC_INFO, (host_info_t)&info, &count);
mach_port_deallocate(mach_task_self(), hostPort);
return (result == KERN_SUCCESS) && (info.cpu_subtype == CPU_SUBTYPE_X86_64_H);
}
#endif
const GradedArchs& GradedArchs::forCurrentOS(bool keysOff, bool osBinariesOnly)
{
#if __arm64e__
if ( osBinariesOnly )
return (keysOff ? arm64e_keysoff_pb : arm64e_pb);
else
return (keysOff ? arm64e_keysoff : arm64e);
#elif __ARM64_ARCH_8_32__
return arm64_32;
#elif __arm64__
return arm64;
#elif __ARM_ARCH_7K__
return armv7k;
#elif __ARM_ARCH_7S__
return armv7s;
#elif __ARM_ARCH_7A__
return armv7;
#elif __x86_64__
#if TARGET_OS_SIMULATOR
return x86_64;
#else
return isHaswell() ? x86_64h : x86_64;
#endif
#elif __i386__
return i386;
#else
#error unknown platform
#endif
}
const GradedArchs& GradedArchs::forName(const char* archName, bool keysOff)
{
if (strcmp(archName, "x86_64h") == 0 )
return x86_64h;
else if (strcmp(archName, "x86_64") == 0 )
return x86_64;
#if SUPPORT_ARCH_arm64e
else if (strcmp(archName, "arm64e") == 0 )
return keysOff ? arm64e_keysoff : arm64e;
#endif
else if (strcmp(archName, "arm64") == 0 )
return arm64;
else if (strcmp(archName, "armv7k") == 0 )
return armv7k;
else if (strcmp(archName, "armv7s") == 0 )
return armv7s;
else if (strcmp(archName, "armv7") == 0 )
return armv7;
#if SUPPORT_ARCH_arm64_32
else if (strcmp(archName, "arm64_32") == 0 )
return arm64_32;
#endif
else if (strcmp(archName, "i386") == 0 )
return i386;
assert(0 && "unknown arch name");
}
//////////////////////////// MachOFile ////////////////////////////////////////
const MachOFile::ArchInfo MachOFile::_s_archInfos[] = {
{ "x86_64", CPU_TYPE_X86_64, CPU_SUBTYPE_X86_64_ALL },
{ "x86_64h", CPU_TYPE_X86_64, CPU_SUBTYPE_X86_64_H },
{ "i386", CPU_TYPE_I386, CPU_SUBTYPE_I386_ALL },
{ "arm64", CPU_TYPE_ARM64, CPU_SUBTYPE_ARM64_ALL },
#if SUPPORT_ARCH_arm64e
{ "arm64e", CPU_TYPE_ARM64, CPU_SUBTYPE_ARM64E },
#endif
#if SUPPORT_ARCH_arm64_32
{ "arm64_32", CPU_TYPE_ARM64_32, CPU_SUBTYPE_ARM64_32_V8 },
#endif
{ "armv7k", CPU_TYPE_ARM, CPU_SUBTYPE_ARM_V7K },
{ "armv7s", CPU_TYPE_ARM, CPU_SUBTYPE_ARM_V7S },
{ "armv7", CPU_TYPE_ARM, CPU_SUBTYPE_ARM_V7 }
};
const MachOFile::PlatformInfo MachOFile::_s_platformInfos[] = {
{ "macOS", Platform::macOS, LC_VERSION_MIN_MACOSX },
{ "iOS", Platform::iOS, LC_VERSION_MIN_IPHONEOS },
{ "tvOS", Platform::tvOS, LC_VERSION_MIN_TVOS },
{ "watchOS", Platform::watchOS, LC_VERSION_MIN_WATCHOS },
{ "bridgeOS", Platform::bridgeOS, LC_BUILD_VERSION },
{ "MacCatalyst", Platform::iOSMac, LC_BUILD_VERSION },
{ "iOS-sim", Platform::iOS_simulator, LC_BUILD_VERSION },
{ "tvOS-sim", Platform::tvOS_simulator, LC_BUILD_VERSION },
{ "watchOS-sim", Platform::watchOS_simulator, LC_BUILD_VERSION },
{ "driverKit", Platform::driverKit, LC_BUILD_VERSION },
};
bool MachOFile::is64() const
{
return (this->magic == MH_MAGIC_64);
}
size_t MachOFile::machHeaderSize() const
{
return is64() ? sizeof(mach_header_64) : sizeof(mach_header);
}
uint32_t MachOFile::maskedCpuSubtype() const
{
return (this->cpusubtype & ~CPU_SUBTYPE_MASK);
}
uint32_t MachOFile::pointerSize() const
{
if (this->magic == MH_MAGIC_64)
return 8;
else
return 4;
}
bool MachOFile::uses16KPages() const
{
switch (this->cputype) {
case CPU_TYPE_ARM64:
case CPU_TYPE_ARM64_32:
return true;
case CPU_TYPE_ARM:
// iOS is 16k aligned for armv7/armv7s and watchOS armv7k is 16k aligned
return this->cpusubtype == CPU_SUBTYPE_ARM_V7K;
default:
return false;
}
}
bool MachOFile::isArch(const char* aName) const
{
return (strcmp(aName, archName(this->cputype, this->cpusubtype)) == 0);
}
const char* MachOFile::archName(uint32_t cputype, uint32_t cpusubtype)
{
for (const ArchInfo& info : _s_archInfos) {
if ( (cputype == info.cputype) && ((cpusubtype & ~CPU_SUBTYPE_MASK) == info.cpusubtype) ) {
return info.name;
}
}
return "unknown";
}
uint32_t MachOFile::cpuTypeFromArchName(const char* archName)
{
for (const ArchInfo& info : _s_archInfos) {
if ( strcmp(archName, info.name) == 0 ) {
return info.cputype;
}
}
return 0;
}
uint32_t MachOFile::cpuSubtypeFromArchName(const char* archName)
{
for (const ArchInfo& info : _s_archInfos) {
if ( strcmp(archName, info.name) == 0 ) {
return info.cpusubtype;
}
}
return 0;
}
const char* MachOFile::archName() const
{
return archName(this->cputype, this->cpusubtype);
}
static void appendDigit(char*& s, unsigned& num, unsigned place, bool& startedPrinting)
{
if ( num >= place ) {
unsigned dig = (num/place);
*s++ = '0' + dig;
num -= (dig*place);
startedPrinting = true;
}
else if ( startedPrinting ) {
*s++ = '0';
}
}
static void appendNumber(char*& s, unsigned num)
{
assert(num < 99999);
bool startedPrinting = false;
appendDigit(s, num, 10000, startedPrinting);
appendDigit(s, num, 1000, startedPrinting);
appendDigit(s, num, 100, startedPrinting);
appendDigit(s, num, 10, startedPrinting);
appendDigit(s, num, 1, startedPrinting);
if ( !startedPrinting )
*s++ = '0';
}
void MachOFile::packedVersionToString(uint32_t packedVersion, char versionString[32])
{
// sprintf(versionString, "%d.%d.%d", (packedVersion >> 16), ((packedVersion >> 8) & 0xFF), (packedVersion & 0xFF));
char* s = versionString;
appendNumber(s, (packedVersion >> 16));
*s++ = '.';
appendNumber(s, (packedVersion >> 8) & 0xFF);
*s++ = '.';
appendNumber(s, (packedVersion & 0xFF));
*s++ = '\0';
}
bool MachOFile::builtForPlatform(Platform reqPlatform, bool onlyOnePlatform) const
{
__block bool foundRequestedPlatform = false;
__block bool foundOtherPlatform = false;
forEachSupportedPlatform(^(Platform platform, uint32_t minOS, uint32_t sdk) {
if ( platform == reqPlatform )
foundRequestedPlatform = true;
else
foundOtherPlatform = true;
});
// if checking that this binary is built for exactly one platform, fail if more
if ( foundOtherPlatform && onlyOnePlatform )
return false;
if ( foundRequestedPlatform )
return true;
// binary has no explict load command to mark platform
// could be an old macOS binary, look at arch
if ( !foundOtherPlatform && (reqPlatform == Platform::macOS) ) {
if ( this->cputype == CPU_TYPE_X86_64 )
return true;
if ( this->cputype == CPU_TYPE_I386 )
return true;
}
#if BUILDING_DYLDINFO
// Allow offline tools to analyze binaries dyld doesn't load, ie, those with platforms
if ( !foundOtherPlatform && (reqPlatform == Platform::unknown) )
return true;
#endif
return false;
}
bool MachOFile::loadableIntoProcess(Platform processPlatform, const char* path) const
{
if ( this->builtForPlatform(processPlatform) )
return true;
// Some host macOS dylibs can be loaded into simulator processes
if ( MachOFile::isSimulatorPlatform(processPlatform) && this->builtForPlatform(Platform::macOS)) {
static const char* const macOSHost[] = {
"/usr/lib/system/libsystem_kernel.dylib",
"/usr/lib/system/libsystem_platform.dylib",
"/usr/lib/system/libsystem_pthread.dylib",
"/usr/lib/system/libsystem_platform_debug.dylib",
"/usr/lib/system/libsystem_pthread_debug.dylib",
"/usr/lib/system/host/liblaunch_sim.dylib",
};
for (const char* libPath : macOSHost) {
if (strcmp(libPath, path) == 0)
return true;
}
}
// If this is being called on main executable where we expect a macOS program, Catalyst programs are also runnable
if ( (this->filetype == MH_EXECUTE) && (processPlatform == Platform::macOS) && this->builtForPlatform(Platform::iOSMac, true) )
return true;
#if (TARGET_OS_OSX && TARGET_CPU_ARM64)
if ( (this->filetype == MH_EXECUTE) && (processPlatform == Platform::macOS) && this->builtForPlatform(Platform::iOS, true) )
return true;
#endif
#if TARGET_FEATURE_REALITYOS
// allow iOS executables to use realityOS dylibs
if ( (processPlatform == Platform::iOS) && this->builtForPlatform(Platform::realityOS, true) )
return true;
// allow iOS_Sim executables to use realityOS_Sim dylibs
if ( (processPlatform == Platform::iOS_simulator) && this->builtForPlatform(Platform::realityOS_simulator, true) )
return true;
#endif
bool iOSonMac = (processPlatform == Platform::iOSMac);
#if (TARGET_OS_OSX && TARGET_CPU_ARM64)
// allow iOS binaries in iOSApp
if ( processPlatform == Platform::iOS ) {
// can load Catalyst binaries into iOS process
if ( this->builtForPlatform(Platform::iOSMac) )
return true;
iOSonMac = true;
}
#endif
// macOS dylibs can be loaded into iOSMac processes
if ( (iOSonMac) && this->builtForPlatform(Platform::macOS, true) )
return true;
return false;
}
bool MachOFile::isZippered() const
{
__block bool macOS = false;
__block bool iOSMac = false;
forEachSupportedPlatform(^(Platform platform, uint32_t minOS, uint32_t sdk) {
if ( platform == Platform::macOS )
macOS = true;
else if ( platform == Platform::iOSMac )
iOSMac = true;
});
return macOS && iOSMac;
}
bool MachOFile::inDyldCache() const {
return (this->flags & MH_DYLIB_IN_CACHE);
}
Platform MachOFile::currentPlatform()
{
#if TARGET_OS_SIMULATOR
#if TARGET_OS_WATCH
return Platform::watchOS_simulator;
#elif TARGET_OS_TV
return Platform::tvOS_simulator;
#elif TARGET_FEATURE_REALITYOS
return Platform::realityOS_simulator;
#else
return Platform::iOS_simulator;
#endif
#elif TARGET_OS_BRIDGE
return Platform::bridgeOS;
#elif TARGET_OS_WATCH
return Platform::watchOS;
#elif TARGET_OS_TV
return Platform::tvOS;
#elif TARGET_OS_IOS
return Platform::iOS;
#elif TARGET_FEATURE_REALITYOS
return Platform::realityOS;
#elif TARGET_OS_OSX
return Platform::macOS;
#elif TARGET_OS_DRIVERKIT
return Platform::driverKit;
#else
#error unknown platform
#endif
}
Platform MachOFile::basePlatform(dyld3::Platform reqPlatform) {
switch(reqPlatform) {
case Platform::unknown: return Platform::unknown;
case Platform::macOS: return Platform::macOS;
case Platform::iOS: return Platform::iOS;
case Platform::tvOS: return Platform::tvOS;
case Platform::watchOS: return Platform::watchOS;
case Platform::bridgeOS: return Platform::bridgeOS;
case Platform::iOSMac: return Platform::iOS;
case Platform::iOS_simulator: return Platform::iOS;
case Platform::tvOS_simulator: return Platform::tvOS;
case Platform::watchOS_simulator: return Platform::watchOS;
case Platform::driverKit: return Platform::driverKit;
default: return Platform::unknown;
}
}
const char* MachOFile::currentArchName()
{
#if __ARM_ARCH_7K__
return "armv7k";
#elif __ARM_ARCH_7A__
return "armv7";
#elif __ARM_ARCH_7S__
return "armv7s";
#elif __arm64e__
return "arm64e";
#elif __arm64__
#if __LP64__
return "arm64";
#else
return "arm64_32";
#endif
#elif __x86_64__
return isHaswell() ? "x86_64h" : "x86_64";
#elif __i386__
return "i386";
#else
#error unknown arch
#endif
}
bool MachOFile::isSimulatorPlatform(Platform platform, Platform* basePlatform)
{
switch ( platform ) {
case Platform::iOS_simulator:
if ( basePlatform )
*basePlatform = Platform::iOS;
return true;
case Platform::watchOS_simulator:
if ( basePlatform )
*basePlatform = Platform::watchOS;
return true;
case Platform::tvOS_simulator:
if ( basePlatform )
*basePlatform = Platform::tvOS;
return true;
default:
return false;
}
}
bool MachOFile::isDyldManaged() const {
switch ( this->filetype ) {
case MH_BUNDLE:
case MH_EXECUTE:
case MH_DYLIB:
return true;
default:
break;
}
return false;
}
bool MachOFile::isDylib() const
{
return (this->filetype == MH_DYLIB);
}
bool MachOFile::isBundle() const
{
return (this->filetype == MH_BUNDLE);
}
bool MachOFile::isMainExecutable() const
{
return (this->filetype == MH_EXECUTE);
}
bool MachOFile::isDynamicExecutable() const
{
if ( this->filetype != MH_EXECUTE )
return false;
// static executables do not have dyld load command
return hasLoadCommand(LC_LOAD_DYLINKER);
}
bool MachOFile::isStaticExecutable() const
{
if ( this->filetype != MH_EXECUTE )
return false;
// static executables do not have dyld load command
return !hasLoadCommand(LC_LOAD_DYLINKER);
}
bool MachOFile::isKextBundle() const
{
return (this->filetype == MH_KEXT_BUNDLE);
}
bool MachOFile::isFileSet() const
{
return (this->filetype == MH_FILESET);
}
bool MachOFile::isPIE() const
{
return (this->flags & MH_PIE);
}
bool MachOFile::isPreload() const
{
return (this->filetype == MH_PRELOAD);
}
const char* MachOFile::platformName(Platform reqPlatform)
{
for (const PlatformInfo& info : _s_platformInfos) {
if ( info.platform == reqPlatform )
return info.name;
}
return "unknown";
}
void MachOFile::forEachSupportedPlatform(void (^handler)(Platform platform, uint32_t minOS, uint32_t sdk)) const
{
Diagnostics diag;
__block bool foundPlatform = false;
forEachLoadCommand(diag, ^(const load_command* cmd, bool& stop) {
const build_version_command* buildCmd = (build_version_command *)cmd;
const version_min_command* versCmd = (version_min_command*)cmd;
uint32_t sdk;
switch ( cmd->cmd ) {
case LC_BUILD_VERSION:
handler((Platform)(buildCmd->platform), buildCmd->minos, buildCmd->sdk);
foundPlatform = true;
break;
case LC_VERSION_MIN_MACOSX:
sdk = versCmd->sdk;
// The original LC_VERSION_MIN_MACOSX did not have an sdk field, assume sdk is same as minOS for those old binaries
if ( sdk == 0 )
sdk = versCmd->version;
handler(Platform::macOS, versCmd->version, sdk);
foundPlatform = true;
break;
case LC_VERSION_MIN_IPHONEOS:
if ( (this->cputype == CPU_TYPE_X86_64) || (this->cputype == CPU_TYPE_I386) )
handler(Platform::iOS_simulator, versCmd->version, versCmd->sdk); // old sim binary
else
handler(Platform::iOS, versCmd->version, versCmd->sdk);
foundPlatform = true;
break;
case LC_VERSION_MIN_TVOS:
if ( this->cputype == CPU_TYPE_X86_64 )
handler(Platform::tvOS_simulator, versCmd->version, versCmd->sdk); // old sim binary
else
handler(Platform::tvOS, versCmd->version, versCmd->sdk);
foundPlatform = true;
break;
case LC_VERSION_MIN_WATCHOS:
if ( (this->cputype == CPU_TYPE_X86_64) || (this->cputype == CPU_TYPE_I386) )
handler(Platform::watchOS_simulator, versCmd->version, versCmd->sdk); // old sim binary
else
handler(Platform::watchOS, versCmd->version, versCmd->sdk);
foundPlatform = true;
break;
}
});
if ( !foundPlatform ) {
// old binary with no explicit platform
#if (BUILDING_DYLD || BUILDING_CLOSURE_UTIL) && TARGET_OS_OSX
if ( this->cputype == CPU_TYPE_X86_64 )
handler(Platform::macOS, 0x000A0500, 0x000A0500); // guess it is a macOS 10.5 binary
// <rdar://problem/75343399>
// The Go linker emits non-standard binaries without a platform and we have to live with it.
if ( this->cputype == CPU_TYPE_ARM64 )
handler(Platform::macOS, 0x000B0000, 0x000B0000); // guess it is a macOS 11.0 binary
#endif
}
diag.assertNoError(); // any malformations in the file should have been caught by earlier validate() call
}
bool MachOFile::isMachO(Diagnostics& diag, uint64_t fileSize) const
{
if ( !hasMachOMagic() ) {
// old PPC slices are not currently valid "mach-o" but should not cause an error
if ( !hasMachOBigEndianMagic() )
diag.error("file does not start with MH_MAGIC[_64]");
return false;
}
if ( this->sizeofcmds + machHeaderSize() > fileSize ) {
diag.error("load commands exceed length of first segment");
return false;
}
forEachLoadCommand(diag, ^(const load_command* cmd, bool& stop) { });
return diag.noError();
}
bool MachOFile::hasMachOMagic() const
{
return ( (this->magic == MH_MAGIC) || (this->magic == MH_MAGIC_64) );
}
bool MachOFile::hasMachOBigEndianMagic() const
{
return ( (this->magic == MH_CIGAM) || (this->magic == MH_CIGAM_64) );
}
void MachOFile::forEachLoadCommand(Diagnostics& diag, void (^callback)(const load_command* cmd, bool& stop)) const
{
bool stop = false;
const load_command* startCmds = nullptr;
if ( this->magic == MH_MAGIC_64 )
startCmds = (load_command*)((char *)this + sizeof(mach_header_64));
else if ( this->magic == MH_MAGIC )
startCmds = (load_command*)((char *)this + sizeof(mach_header));
else if ( hasMachOBigEndianMagic() )
return; // can't process big endian mach-o
else {
const uint32_t* h = (uint32_t*)this;
diag.error("file does not start with MH_MAGIC[_64]: 0x%08X 0x%08X", h[0], h [1]);
return; // not a mach-o file
}
const load_command* const cmdsEnd = (load_command*)((char*)startCmds + this->sizeofcmds);
const load_command* cmd = startCmds;
for (uint32_t i = 0; i < this->ncmds; ++i) {
const load_command* nextCmd = (load_command*)((char *)cmd + cmd->cmdsize);
if ( cmd->cmdsize < 8 ) {
diag.error("malformed load command #%d of %d at %p with mh=%p, size (0x%X) too small", i, this->ncmds, cmd, this, cmd->cmdsize);
return;
}
// FIXME: add check the cmdsize is pointer aligned (might reveal bin compat issues)
if ( (nextCmd > cmdsEnd) || (nextCmd < startCmds) ) {
diag.error("malformed load command #%d of %d at %p with mh=%p, size (0x%X) is too large, load commands end at %p", i, this->ncmds, cmd, this, cmd->cmdsize, cmdsEnd);
return;
}
callback(cmd, stop);
if ( stop )
return;
cmd = nextCmd;
}
}
void MachOFile::removeLoadCommand(Diagnostics& diag, void (^callback)(const load_command* cmd, bool& remove, bool& stop))
{
bool stop = false;
const load_command* startCmds = nullptr;
if ( this->magic == MH_MAGIC_64 )
startCmds = (load_command*)((char *)this + sizeof(mach_header_64));
else if ( this->magic == MH_MAGIC )
startCmds = (load_command*)((char *)this + sizeof(mach_header));
else if ( hasMachOBigEndianMagic() )
return; // can't process big endian mach-o
else {
const uint32_t* h = (uint32_t*)this;
diag.error("file does not start with MH_MAGIC[_64]: 0x%08X 0x%08X", h[0], h [1]);
return; // not a mach-o file
}
const load_command* const cmdsEnd = (load_command*)((char*)startCmds + this->sizeofcmds);
auto cmd = (load_command*)startCmds;
const uint32_t origNcmds = this->ncmds;
unsigned bytesRemaining = this->sizeofcmds;
for (uint32_t i = 0; i < origNcmds; ++i) {
bool remove = false;
auto nextCmd = (load_command*)((char *)cmd + cmd->cmdsize);
if ( cmd->cmdsize < 8 ) {
diag.error("malformed load command #%d of %d at %p with mh=%p, size (0x%X) too small", i, this->ncmds, cmd, this, cmd->cmdsize);
return;
}
if ( (nextCmd > cmdsEnd) || (nextCmd < startCmds) ) {
diag.error("malformed load command #%d of %d at %p with mh=%p, size (0x%X) is too large, load commands end at %p", i, this->ncmds, cmd, this, cmd->cmdsize, cmdsEnd);
return;
}
callback(cmd, remove, stop);
if ( remove ) {
this->sizeofcmds -= cmd->cmdsize;
::memmove((void*)cmd, (void*)nextCmd, bytesRemaining);
this->ncmds--;
} else {
bytesRemaining -= cmd->cmdsize;
cmd = nextCmd;
}
if ( stop )
break;
}
if ( cmd )
::bzero(cmd, bytesRemaining);
}
const char* MachOFile::installName() const
{
const char* name;
uint32_t compatVersion;
uint32_t currentVersion;
if ( getDylibInstallName(&name, &compatVersion, ¤tVersion) )
return name;
return nullptr;
}
bool MachOFile::getDylibInstallName(const char** installName, uint32_t* compatVersion, uint32_t* currentVersion) const
{
Diagnostics diag;
__block bool found = false;
forEachLoadCommand(diag, ^(const load_command* cmd, bool& stop) {
if ( cmd->cmd == LC_ID_DYLIB ) {
const dylib_command* dylibCmd = (dylib_command*)cmd;
*compatVersion = dylibCmd->dylib.compatibility_version;
*currentVersion = dylibCmd->dylib.current_version;
*installName = (char*)dylibCmd + dylibCmd->dylib.name.offset;
found = true;
stop = true;
}
});
diag.assertNoError(); // any malformations in the file should have been caught by earlier validate() call
return found;
}
bool MachOFile::getUuid(uuid_t uuid) const
{
Diagnostics diag;
__block bool found = false;
forEachLoadCommand(diag, ^(const load_command* cmd, bool& stop) {
if ( cmd->cmd == LC_UUID ) {
const uuid_command* uc = (const uuid_command*)cmd;
memcpy(uuid, uc->uuid, sizeof(uuid_t));
found = true;
stop = true;
}
});
diag.assertNoError(); // any malformations in the file should have been caught by earlier validate() call
if ( !found )
bzero(uuid, sizeof(uuid_t));