-
-
Notifications
You must be signed in to change notification settings - Fork 90
/
objc-block-trampolines.mm
613 lines (505 loc) · 20.8 KB
/
objc-block-trampolines.mm
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
/*
* Copyright (c) 2010 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@
*/
/***********************************************************************
* objc-block-trampolines.m
* Author: b.bum
*
**********************************************************************/
/***********************************************************************
* Imports.
**********************************************************************/
#include "objc-private.h"
#include "runtime.h"
#include <Block.h>
#include <Block_private.h>
#include <mach/mach.h>
#include <objc/objc-block-trampolines.h>
// fixme C++ compilers don't implemement memory_order_consume efficiently.
// Use memory_order_relaxed and cross our fingers.
#define MEMORY_ORDER_CONSUME std::memory_order_relaxed
// 8 bytes of text and data per trampoline on all architectures.
#define SLOT_SIZE 8
// The trampolines are defined in assembly files in libobjc-trampolines.dylib.
// We can't link to libobjc-trampolines.dylib directly because
// for security reasons it isn't in the dyld shared cache.
// Trampoline addresses are lazily looked up.
// All of them are hidden behind a single atomic pointer for lock-free init.
#ifdef __PTRAUTH_INTRINSICS__
# define TrampolinePtrauth __ptrauth(ptrauth_key_function_pointer, 1, 0x3af1)
#else
# define TrampolinePtrauth
#endif
// A page of trampolines is as big as the maximum supported page size
// everywhere except i386. i386 only exists for the watch simulator
// now, and we know it really only has 4kB pages. Also see comments
// below about PAGE_SIZE and PAGE_MAX_SIZE.
#ifdef __i386__
#define TRAMPOLINE_PAGE_SIZE PAGE_MIN_SIZE
#else
#define TRAMPOLINE_PAGE_SIZE PAGE_MAX_SIZE
#endif
class TrampolinePointerWrapper {
struct TrampolinePointers {
class TrampolineAddress {
const void * TrampolinePtrauth storage;
public:
TrampolineAddress(void *dylib, const char *name) {
#define PREFIX "_objc_blockTrampoline"
char symbol[strlen(PREFIX) + strlen(name) + 1];
strcpy(symbol, PREFIX);
strcat(symbol, name);
// dlsym() from a text segment returns a signed pointer
// Authenticate it manually and let the compiler re-sign it.
storage = ptrauth_auth_data(dlsym(dylib, symbol),
ptrauth_key_function_pointer, 0);
if (!storage) {
_objc_fatal("couldn't dlsym %s", symbol);
}
}
uintptr_t address() {
return (uintptr_t)(void*)storage;
}
};
TrampolineAddress impl; // trampoline header code
TrampolineAddress start; // first trampoline
#if DEBUG
// These symbols are only used in assertions.
// fixme might be able to move the assertions to libobjc-trampolines itself
TrampolineAddress last; // start of the last trampoline
// We don't use the address after the last trampoline because that
// address might be in a different section, and then dlsym() would not
// sign it as a function pointer.
# if SUPPORT_STRET
TrampolineAddress impl_stret;
TrampolineAddress start_stret;
TrampolineAddress last_stret;
# endif
#endif
uintptr_t textSegment;
uintptr_t textSegmentSize;
void check() {
#if DEBUG
ASSERT(impl.address() == textSegment + TRAMPOLINE_PAGE_SIZE);
ASSERT(impl.address() % PAGE_SIZE == 0); // not TRAMPOLINE_PAGE_SIZE
ASSERT(impl.address() + TRAMPOLINE_PAGE_SIZE ==
last.address() + SLOT_SIZE);
ASSERT(last.address()+8 < textSegment + textSegmentSize);
ASSERT((last.address() - start.address()) % SLOT_SIZE == 0);
# if SUPPORT_STRET
ASSERT(impl_stret.address() == textSegment + 2*TRAMPOLINE_PAGE_SIZE);
ASSERT(impl_stret.address() % PAGE_SIZE == 0); // not TRAMPOLINE_PAGE_SIZE
ASSERT(impl_stret.address() + TRAMPOLINE_PAGE_SIZE ==
last_stret.address() + SLOT_SIZE);
ASSERT(start.address() - impl.address() ==
start_stret.address() - impl_stret.address());
ASSERT(last_stret.address() + SLOT_SIZE <
textSegment + textSegmentSize);
ASSERT((last_stret.address() - start_stret.address())
% SLOT_SIZE == 0);
# endif
#endif
}
TrampolinePointers(void *dylib)
: impl(dylib, "Impl")
, start(dylib, "Start")
#if DEBUG
, last(dylib, "Last")
# if SUPPORT_STRET
, impl_stret(dylib, "Impl_stret")
, start_stret(dylib, "Start_stret")
, last_stret(dylib, "Last_stret")
# endif
#endif
{
const auto *mh =
dyld_image_header_containing_address((void *)impl.address());
unsigned long size = 0;
textSegment = (uintptr_t)
getsegmentdata((headerType *)mh, "__TEXT", &size);
textSegmentSize = size;
check();
}
};
std::atomic<TrampolinePointers *> trampolines{nil};
TrampolinePointers *get() {
return trampolines.load(MEMORY_ORDER_CONSUME);
}
public:
void Initialize() {
if (get()) return;
// This code may be called concurrently.
// In the worst case we perform extra dyld operations.
void *dylib = dlopen("/usr/lib/libobjc-trampolines.dylib",
RTLD_NOW | RTLD_LOCAL | RTLD_FIRST);
if (!dylib) {
_objc_fatal("couldn't dlopen libobjc-trampolines.dylib: %s",
dlerror());
}
auto t = new TrampolinePointers(dylib);
TrampolinePointers *old = nil;
if (! trampolines.compare_exchange_strong(old, t, memory_order_release))
{
delete t; // Lost an initialization race.
}
}
uintptr_t textSegment() { return get()->textSegment; }
uintptr_t textSegmentSize() { return get()->textSegmentSize; }
uintptr_t dataSize() { return TRAMPOLINE_PAGE_SIZE; }
uintptr_t impl() { return get()->impl.address(); }
uintptr_t start() { return get()->start.address(); }
};
static TrampolinePointerWrapper Trampolines;
// argument mode identifier
// Some calculations assume that these modes are sequential starting from 0.
// This order must match the order of the trampoline's assembly code.
typedef enum {
ReturnValueInRegisterArgumentMode,
#if SUPPORT_STRET
ReturnValueOnStackArgumentMode,
#endif
ArgumentModeCount
} ArgumentMode;
// We must take care with our data layout on architectures that support
// multiple page sizes.
//
// The trampoline template in __TEXT is sized and aligned with PAGE_MAX_SIZE,
// except on i386 which is a weird special case that uses PAGE_MIN_SIZE.
// The TRAMPOLINE_PAGE_SIZE macro handles this difference. On some platforms,
// aligning to PAGE_MAX_SIZE requires additional linker flags.
//
// When we allocate a page group, we use TRAMPOLINE_PAGE_SIZE size.
// This allows trampoline code to find its data by subtracting TRAMPOLINE_PAGE_SIZE.
//
// When we allocate a page group, we use the process's page alignment.
// This simplifies allocation because we don't need to force greater than
// default alignment when running with small pages, but it also means
// the trampoline code MUST NOT look for its data by masking with PAGE_MAX_MASK.
struct TrampolineBlockPageGroup
{
TrampolineBlockPageGroup *nextPageGroup; // linked list of all pages
TrampolineBlockPageGroup *nextAvailablePage; // linked list of pages with available slots
uintptr_t nextAvailable; // index of next available slot, endIndex() if no more available
const void * TrampolinePtrauth const text; // text VM region; stored only for the benefit of the leaks tool
TrampolineBlockPageGroup()
: nextPageGroup(nil)
, nextAvailablePage(nil)
, nextAvailable(startIndex())
, text((const void *)((uintptr_t)this + Trampolines.dataSize()))
{ }
// Payload data: block pointers and free list.
// Bytes parallel with trampoline header code are the fields above or unused
// uint8_t payloads[TRAMPOLINE_PAGE_SIZE - sizeof(TrampolineBlockPageGroup)]
// Code: Mach-O header, then trampoline header followed by trampolines.
// On platforms with struct return we have non-stret trampolines and
// stret trampolines. The stret and non-stret trampolines at a given
// index share the same data page.
// uint8_t macho[TRAMPOLINE_PAGE_SIZE];
// uint8_t trampolines[ArgumentModeCount][TRAMPOLINE_PAGE_SIZE];
// Per-trampoline block data format:
// initial value is 0 while page data is filled sequentially
// when filled, value is reference to Block_copy()d block
// when empty, value is index of next available slot OR 0 if never used yet
union Payload {
id block;
uintptr_t nextAvailable; // free list
};
static uintptr_t headerSize() {
return (uintptr_t) (Trampolines.start() - Trampolines.impl());
}
static uintptr_t slotSize() {
return SLOT_SIZE;
}
static uintptr_t startIndex() {
// headerSize is assumed to be slot-aligned
return headerSize() / slotSize();
}
static uintptr_t endIndex() {
return (uintptr_t)Trampolines.dataSize() / slotSize();
}
static bool validIndex(uintptr_t index) {
return (index >= startIndex() && index < endIndex());
}
Payload *payload(uintptr_t index) {
ASSERT(validIndex(index));
return (Payload *)((char *)this + index*slotSize());
}
uintptr_t trampolinesForMode(int aMode) {
// Skip over the data area, one page of Mach-O headers,
// and one text page for each mode before this one.
return (uintptr_t)this + Trampolines.dataSize() +
TRAMPOLINE_PAGE_SIZE * (1 + aMode);
}
IMP trampoline(int aMode, uintptr_t index) {
ASSERT(validIndex(index));
char *base = (char *)trampolinesForMode(aMode);
char *imp = base + index*slotSize();
#if __arm__
imp++; // trampoline is Thumb instructions
#endif
#if __has_feature(ptrauth_calls)
imp = ptrauth_sign_unauthenticated(imp,
ptrauth_key_function_pointer, 0);
#endif
return (IMP)imp;
}
uintptr_t indexForTrampoline(uintptr_t tramp) {
for (int aMode = 0; aMode < ArgumentModeCount; aMode++) {
uintptr_t base = trampolinesForMode(aMode);
uintptr_t start = base + startIndex() * slotSize();
uintptr_t end = base + endIndex() * slotSize();
if (tramp >= start && tramp < end) {
return (uintptr_t)(tramp - base) / slotSize();
}
}
return 0;
}
static void check() {
ASSERT(TrampolineBlockPageGroup::headerSize() >= sizeof(TrampolineBlockPageGroup));
ASSERT(TrampolineBlockPageGroup::headerSize() % TrampolineBlockPageGroup::slotSize() == 0);
}
};
static TrampolineBlockPageGroup *HeadPageGroup;
#pragma mark Utility Functions
#if !__OBJC2__
#define runtimeLock classLock
#endif
#pragma mark Trampoline Management Functions
static TrampolineBlockPageGroup *_allocateTrampolinesAndData()
{
runtimeLock.assertLocked();
vm_address_t dataAddress;
TrampolineBlockPageGroup::check();
// Our final mapping will look roughly like this:
// r/w data
// r/o text mapped from libobjc-trampolines.dylib
// with fixed offsets from the text to the data embedded in the text.
//
// More precisely it will look like this:
// 1 page r/w data
// 1 page libobjc-trampolines.dylib Mach-O header
// N pages trampoline code, one for each ArgumentMode
// M pages for the rest of libobjc-trampolines' TEXT segment.
// The kernel requires that we remap the entire TEXT segment every time.
// We assume that our code begins on the second TEXT page, but are robust
// against other additions to the end of the TEXT segment.
ASSERT(HeadPageGroup == nil || HeadPageGroup->nextAvailablePage == nil);
auto textSource = Trampolines.textSegment();
auto textSourceSize = Trampolines.textSegmentSize();
auto dataSize = Trampolines.dataSize();
// Allocate a single contiguous region big enough to hold data+text.
kern_return_t result;
result = vm_allocate(mach_task_self(), &dataAddress,
dataSize + textSourceSize,
VM_FLAGS_ANYWHERE | VM_MAKE_TAG(VM_MEMORY_FOUNDATION));
if (result != KERN_SUCCESS) {
_objc_fatal("vm_allocate trampolines failed (%d)", result);
}
// Remap libobjc-trampolines' TEXT segment atop all
// but the first of the pages we just allocated:
vm_address_t textDest = dataAddress + dataSize;
vm_prot_t currentProtection, maxProtection;
result = vm_remap(mach_task_self(), &textDest,
textSourceSize,
0, VM_FLAGS_FIXED | VM_FLAGS_OVERWRITE,
mach_task_self(), textSource, TRUE,
¤tProtection, &maxProtection, VM_INHERIT_SHARE);
if (result != KERN_SUCCESS) {
_objc_fatal("vm_remap trampolines failed (%d)", result);
}
auto *pageGroup = new ((void*)dataAddress) TrampolineBlockPageGroup;
if (HeadPageGroup) {
TrampolineBlockPageGroup *lastPageGroup = HeadPageGroup;
while(lastPageGroup->nextPageGroup) {
lastPageGroup = lastPageGroup->nextPageGroup;
}
lastPageGroup->nextPageGroup = pageGroup;
HeadPageGroup->nextAvailablePage = pageGroup;
} else {
HeadPageGroup = pageGroup;
}
return pageGroup;
}
static TrampolineBlockPageGroup *
getOrAllocatePageGroupWithNextAvailable()
{
runtimeLock.assertLocked();
if (!HeadPageGroup)
return _allocateTrampolinesAndData();
// make sure head page is filled first
if (HeadPageGroup->nextAvailable != HeadPageGroup->endIndex())
return HeadPageGroup;
if (HeadPageGroup->nextAvailablePage) // check if there is a page w/a hole
return HeadPageGroup->nextAvailablePage;
return _allocateTrampolinesAndData(); // tack on a new one
}
static TrampolineBlockPageGroup *
pageAndIndexContainingIMP(IMP anImp, uintptr_t *outIndex)
{
runtimeLock.assertLocked();
// Authenticate as a function pointer, returning an un-signed address.
uintptr_t trampAddress =
(uintptr_t)ptrauth_auth_data((const char *)anImp,
ptrauth_key_function_pointer, 0);
for (TrampolineBlockPageGroup *pageGroup = HeadPageGroup;
pageGroup;
pageGroup = pageGroup->nextPageGroup)
{
uintptr_t index = pageGroup->indexForTrampoline(trampAddress);
if (index) {
if (outIndex) *outIndex = index;
return pageGroup;
}
}
return nil;
}
static ArgumentMode
argumentModeForBlock(id block)
{
ArgumentMode aMode = ReturnValueInRegisterArgumentMode;
#if SUPPORT_STRET
if (_Block_has_signature(block) && _Block_use_stret(block))
aMode = ReturnValueOnStackArgumentMode;
#else
ASSERT(! (_Block_has_signature(block) && _Block_use_stret(block)));
#endif
return aMode;
}
/// Initialize the trampoline machinery. Normally this does nothing, as
/// everything is initialized lazily, but for certain processes we eagerly load
/// the trampolines dylib.
void
_imp_implementationWithBlock_init(void)
{
#if TARGET_OS_OSX
// Eagerly load libobjc-trampolines.dylib in certain processes. Some
// programs (most notably QtWebEngineProcess used by older versions of
// embedded Chromium) enable a highly restrictive sandbox profile which
// blocks access to that dylib. If anything calls
// imp_implementationWithBlock (as AppKit has started doing) then we'll
// crash trying to load it. Loading it here sets it up before the sandbox
// profile is enabled and blocks it.
//
// This fixes EA Origin (rdar://problem/50813789)
// and Steam (rdar://problem/55286131)
if (__progname &&
(strcmp(__progname, "QtWebEngineProcess") == 0 ||
strcmp(__progname, "Steam Helper") == 0)) {
Trampolines.Initialize();
}
#endif
}
// `block` must already have been copied
IMP
_imp_implementationWithBlockNoCopy(id block)
{
runtimeLock.assertLocked();
TrampolineBlockPageGroup *pageGroup =
getOrAllocatePageGroupWithNextAvailable();
uintptr_t index = pageGroup->nextAvailable;
ASSERT(index >= pageGroup->startIndex() && index < pageGroup->endIndex());
TrampolineBlockPageGroup::Payload *payload = pageGroup->payload(index);
uintptr_t nextAvailableIndex = payload->nextAvailable;
if (nextAvailableIndex == 0) {
// First time through (unused slots are zero). Fill sequentially.
// If the page is now full this will now be endIndex(), handled below.
nextAvailableIndex = index + 1;
}
pageGroup->nextAvailable = nextAvailableIndex;
if (nextAvailableIndex == pageGroup->endIndex()) {
// PageGroup is now full (free list or wilderness exhausted)
// Remove from available page linked list
TrampolineBlockPageGroup *iterator = HeadPageGroup;
while(iterator && (iterator->nextAvailablePage != pageGroup)) {
iterator = iterator->nextAvailablePage;
}
if (iterator) {
iterator->nextAvailablePage = pageGroup->nextAvailablePage;
pageGroup->nextAvailablePage = nil;
}
}
payload->block = block;
return pageGroup->trampoline(argumentModeForBlock(block), index);
}
#pragma mark Public API
IMP imp_implementationWithBlock(id block)
{
// Block object must be copied outside runtimeLock
// because it performs arbitrary work.
block = Block_copy(block);
// Trampolines must be initialized outside runtimeLock
// because it calls dlopen().
Trampolines.Initialize();
mutex_locker_t lock(runtimeLock);
return _imp_implementationWithBlockNoCopy(block);
}
id imp_getBlock(IMP anImp) {
uintptr_t index;
TrampolineBlockPageGroup *pageGroup;
if (!anImp) return nil;
mutex_locker_t lock(runtimeLock);
pageGroup = pageAndIndexContainingIMP(anImp, &index);
if (!pageGroup) {
return nil;
}
TrampolineBlockPageGroup::Payload *payload = pageGroup->payload(index);
if (payload->nextAvailable <= TrampolineBlockPageGroup::endIndex()) {
// unallocated
return nil;
}
return payload->block;
}
BOOL imp_removeBlock(IMP anImp) {
if (!anImp) return NO;
id block;
{
mutex_locker_t lock(runtimeLock);
uintptr_t index;
TrampolineBlockPageGroup *pageGroup =
pageAndIndexContainingIMP(anImp, &index);
if (!pageGroup) {
return NO;
}
TrampolineBlockPageGroup::Payload *payload = pageGroup->payload(index);
block = payload->block;
// block is released below, outside the lock
payload->nextAvailable = pageGroup->nextAvailable;
pageGroup->nextAvailable = index;
// make sure this page is on available linked list
TrampolineBlockPageGroup *pageGroupIterator = HeadPageGroup;
// see if page is the next available page for any existing pages
while (pageGroupIterator->nextAvailablePage &&
pageGroupIterator->nextAvailablePage != pageGroup)
{
pageGroupIterator = pageGroupIterator->nextAvailablePage;
}
if (! pageGroupIterator->nextAvailablePage) {
// if iteration stopped because nextAvail was nil
// add to end of list.
pageGroupIterator->nextAvailablePage = pageGroup;
pageGroup->nextAvailablePage = nil;
}
}
// do this AFTER dropping the lock
Block_release(block);
return YES;
}