-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
Copy pathmachexception.cpp
1365 lines (1154 loc) · 50.1 KB
/
machexception.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
//-------------------------------------------------------------------------------------------------------
// ChakraCore/Pal
// Contains portions (c) copyright Microsoft, portions copyright (c) the .NET Foundation and Contributors
// and edits (c) copyright the ChakraCore Contributors.
// See THIRD-PARTY-NOTICES.txt in the project root for .NET Foundation license
// Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
//-------------------------------------------------------------------------------------------------------
/*++
Module Name:
machexception.cpp
Abstract:
Implementation of MACH exception API functions.
--*/
#include "pal/dbgmsg.h"
SET_DEFAULT_DEBUG_CHANNEL(EXCEPT); // some headers have code with asserts, so do this first
#include "pal/thread.hpp"
#include "pal/palinternal.h"
#if HAVE_MACH_EXCEPTIONS
#include "machexception.h"
#include "pal/critsect.h"
#include "pal/debug.h"
#include "pal/init.h"
#include "pal/utils.h"
#include "pal/context.h"
#include "pal/malloc.hpp"
#include "pal/process.h"
#include "pal/virtual.h"
#include "pal/map.hpp"
#include "machmessage.h"
#include <errno.h>
#include <string.h>
#include <unistd.h>
#include <pthread.h>
#include <dlfcn.h>
#include <mach-o/loader.h>
#include <sys/mman.h>
using namespace CorUnix;
// The port we use to handle exceptions and to set the thread context
mach_port_t s_ExceptionPort;
static DWORD s_PalInitializeFlags = 0;
static const char * PAL_MACH_EXCEPTION_MODE = "PAL_MachExceptionMode";
// This struct is used to track the threads that need to have an exception forwarded
// to the next thread level port in the chain (if exists). An entry is added by the
// faulting sending a special message to the exception thread which saves it on an
// list that is searched when the restarted exception notification is received again.
struct ForwardedException
{
ForwardedException *m_next;
thread_act_t Thread;
exception_type_t ExceptionType;
CPalThread *PalThread;
};
// The singly linked list and enumerator for the ForwardException struct
struct ForwardedExceptionList
{
private:
ForwardedException *m_head;
ForwardedException *m_previous;
public:
ForwardedException *Current;
ForwardedExceptionList()
{
m_head = NULL;
MoveFirst();
}
void MoveFirst()
{
Current = m_head;
m_previous = NULL;
}
bool IsEOL()
{
return Current == NULL;
}
void MoveNext()
{
m_previous = Current;
Current = Current->m_next;
}
void Add(ForwardedException *item)
{
item->m_next = m_head;
m_head = item;
}
void Delete()
{
if (m_previous == NULL)
{
m_head = Current->m_next;
}
else
{
m_previous->m_next = Current->m_next;
}
free(Current);
Current = m_head;
m_previous = NULL;
}
};
enum MachExceptionMode
{
// special value to indicate we've not initialized yet
MachException_Uninitialized = -1,
// These can be combined with bitwise OR to incrementally turn off
// functionality for diagnostics purposes.
//
// In practice, the following values are probably useful:
// 1: Don't turn illegal instructions into SEH exceptions.
// On Intel, stack misalignment usually shows up as an
// illegal instruction. PAL client code shouldn't
// expect to see any of these, so this option should
// always be safe to set.
// 2: Don't listen for breakpoint exceptions. This makes an
// SEH-based debugger (i.e., managed debugger) unusable,
// but you may need this option if you find that native
// breakpoints you set in PAL-dependent code don't work
// (causing hangs or crashes in the native debugger).
// 3: Combination of the above.
// This is the typical setting for development
// (unless you're working on the managed debugger).
// 7: In addition to the above, don't turn bad accesses and
// arithmetic exceptions into SEH.
// This is the typical setting for stress.
MachException_SuppressIllegal = 1,
MachException_SuppressDebugging = 2,
MachException_SuppressManaged = 4,
// Default value to use if environment variable not set.
MachException_Default = 0,
};
/*++
Function :
GetExceptionMask()
Returns the mach exception mask for the exceptions to hook for a thread.
Return value :
mach exception mask
--*/
static
exception_mask_t
GetExceptionMask()
{
static MachExceptionMode exMode = MachException_Uninitialized;
if (exMode == MachException_Uninitialized)
{
exMode = MachException_Default;
const char * exceptionSettings = getenv(PAL_MACH_EXCEPTION_MODE);
if (exceptionSettings)
{
exMode = (MachExceptionMode)atoi(exceptionSettings);
free((void*)exceptionSettings);
}
else
{
if (PAL_IsDebuggerPresent())
{
exMode = MachException_SuppressDebugging;
}
}
}
exception_mask_t machExceptionMask = 0;
if (!(exMode & MachException_SuppressIllegal))
{
machExceptionMask |= PAL_EXC_ILLEGAL_MASK;
}
if (!(exMode & MachException_SuppressManaged))
{
machExceptionMask |= PAL_EXC_MANAGED_MASK;
}
return machExceptionMask;
}
/*++
Function :
CPalThread::EnableMachExceptions
Hook Mach exceptions, i.e., call thread_swap_exception_ports
to replace the thread's current exception ports with our own.
The previously active exception ports are saved. Called when
this thread enters a region of code that depends on this PAL.
Return value :
ERROR_SUCCESS, if enabling succeeded
an error code, otherwise
--*/
PAL_ERROR CorUnix::CPalThread::EnableMachExceptions()
{
TRACE("%08X: Enter()\n", (unsigned int)(size_t)this);
exception_mask_t machExceptionMask = GetExceptionMask();
if (machExceptionMask != 0)
{
#ifdef _DEBUG
// verify that the arrays we've allocated to hold saved exception ports
// are the right size.
exception_mask_t countBits = PAL_EXC_ALL_MASK;
countBits = ((countBits & 0xAAAAAAAA) >> 1) + (countBits & 0x55555555);
countBits = ((countBits & 0xCCCCCCCC) >> 2) + (countBits & 0x33333333);
countBits = ((countBits & 0xF0F0F0F0) >> 4) + (countBits & 0x0F0F0F0F);
countBits = ((countBits & 0xFF00FF00) >> 8) + (countBits & 0x00FF00FF);
countBits = ((countBits & 0xFFFF0000) >> 16) + (countBits & 0x0000FFFF);
if (countBits != static_cast<exception_mask_t>(CThreadMachExceptionHandlers::s_nPortsMax))
{
ASSERT("s_nPortsMax is %u, but needs to be %u\n",
CThreadMachExceptionHandlers::s_nPortsMax, countBits);
}
#endif // _DEBUG
NONPAL_TRACE("Enabling handlers for thread %08x exception mask %08x exception port %08x\n",
GetMachPortSelf(), machExceptionMask, s_ExceptionPort);
CThreadMachExceptionHandlers *pSavedHandlers = GetSavedMachHandlers();
// Swap current handlers into temporary storage first. That's because it's possible (even likely) that
// some or all of the handlers might still be ours. In those cases we don't want to overwrite the
// chain-back entries with these useless self-references.
kern_return_t machret;
kern_return_t machretDeallocate;
thread_port_t thread = mach_thread_self();
machret = thread_swap_exception_ports(
thread,
machExceptionMask,
s_ExceptionPort,
EXCEPTION_DEFAULT | MACH_EXCEPTION_CODES,
THREAD_STATE_NONE,
pSavedHandlers->m_masks,
&pSavedHandlers->m_nPorts,
pSavedHandlers->m_handlers,
pSavedHandlers->m_behaviors,
pSavedHandlers->m_flavors);
machretDeallocate = mach_port_deallocate(mach_task_self(), thread);
CHECK_MACH("mach_port_deallocate", machretDeallocate);
if (machret != KERN_SUCCESS)
{
ASSERT("thread_swap_exception_ports failed: %d %s\n", machret, mach_error_string(machret));
return UTIL_MachErrorToPalError(machret);
}
#ifdef _DEBUG
NONPAL_TRACE("EnableMachExceptions: THREAD PORT count %d\n", pSavedHandlers->m_nPorts);
for (mach_msg_type_number_t i = 0; i < pSavedHandlers->m_nPorts; i++)
{
_ASSERTE(pSavedHandlers->m_handlers[i] != s_ExceptionPort);
NONPAL_TRACE("EnableMachExceptions: THREAD PORT mask %08x handler: %08x behavior %08x flavor %u\n",
pSavedHandlers->m_masks[i],
pSavedHandlers->m_handlers[i],
pSavedHandlers->m_behaviors[i],
pSavedHandlers->m_flavors[i]);
}
#endif // _DEBUG
}
return ERROR_SUCCESS;
}
/*++
Function :
CPalThread::DisableMachExceptions
Unhook Mach exceptions, i.e., call thread_set_exception_ports
to restore the thread's exception ports with those we saved
in EnableMachExceptions. Called when this thread leaves a
region of code that depends on this PAL.
Return value :
ERROR_SUCCESS, if disabling succeeded
an error code, otherwise
--*/
PAL_ERROR CorUnix::CPalThread::DisableMachExceptions()
{
TRACE("%08X: Leave()\n", (unsigned int)(size_t)this);
PAL_ERROR palError = NO_ERROR;
// We only store exceptions when we're installing exceptions.
if (0 == GetExceptionMask())
return palError;
// Get the handlers to restore.
CThreadMachExceptionHandlers *savedPorts = GetSavedMachHandlers();
kern_return_t MachRet = KERN_SUCCESS;
for (int i = 0; i < savedPorts->m_nPorts; i++)
{
// If no handler was ever set, thread_swap_exception_ports returns
// MACH_PORT_NULL for the handler and zero values for behavior
// and flavor. Unfortunately, the latter are invalid even for
// MACH_PORT_NULL when you use thread_set_exception_ports.
exception_behavior_t behavior = savedPorts->m_behaviors[i] ? savedPorts->m_behaviors[i] : EXCEPTION_DEFAULT;
thread_state_flavor_t flavor = savedPorts->m_flavors[i] ? savedPorts->m_flavors[i] : MACHINE_THREAD_STATE;
thread_port_t thread = mach_thread_self();
MachRet = thread_set_exception_ports(thread,
savedPorts->m_masks[i],
savedPorts->m_handlers[i],
behavior,
flavor);
kern_return_t MachRetDeallocate = mach_port_deallocate(mach_task_self(), thread);
CHECK_MACH("mach_port_deallocate", MachRetDeallocate);
if (MachRet != KERN_SUCCESS)
break;
}
if (MachRet != KERN_SUCCESS)
{
ASSERT("thread_set_exception_ports failed: %d\n", MachRet);
palError = UTIL_MachErrorToPalError(MachRet);
}
return palError;
}
#if defined(__amd64__)
// Since HijackFaultingThread pushed the context, exception record and info on the stack, we need to adjust the
// signature of PAL_DispatchException such that the corresponding arguments are considered to be on the stack
// per GCC64 calling convention rules. Hence, the first 6 dummy arguments (corresponding to RDI, RSI, RDX,RCX, R8, R9).
extern "C"
void PAL_DispatchException(DWORD64 dwRDI, DWORD64 dwRSI, DWORD64 dwRDX, DWORD64 dwRCX, DWORD64 dwR8, DWORD64 dwR9, PCONTEXT pContext, PEXCEPTION_RECORD pExRecord, MachExceptionInfo *pMachExceptionInfo)
#elif defined(_ARM64_)
extern "C"
void PAL_DispatchException(PCONTEXT pContext, PEXCEPTION_RECORD pExRecord, MachExceptionInfo *pMachExceptionInfo)
#endif
{
CPalThread *pThread = InternalGetCurrentThread();
#if FEATURE_PAL_SXS
if (!pThread->IsInPal())
{
// It's now possible to observe system exceptions in code running outside the PAL (as the result of a
// p/invoke since we no longer revert our Mach exception ports in this case). In that scenario we need
// to re-enter the PAL now as the exception signals the end of the p/invoke.
PAL_Reenter(PAL_BoundaryBottom);
}
#endif // FEATURE_PAL_SXS
raise(SIGINT);
abort();
}
extern "C" void PAL_DispatchExceptionWrapper();
extern "C" int PAL_DispatchExceptionReturnOffset;
/*++
Function :
BuildExceptionRecord
Sets up up an ExceptionRecord from an exception message
Parameters :
exceptionInfo - exception info to build the exception record
pExceptionRecord - exception record to setup
*/
static
void
BuildExceptionRecord(
MachExceptionInfo& exceptionInfo, // [in] exception info
EXCEPTION_RECORD *pExceptionRecord) // [out] Used to return exception parameters
{
memset(pExceptionRecord, 0, sizeof(EXCEPTION_RECORD));
DWORD exceptionCode = EXCEPTION_ILLEGAL_INSTRUCTION;
switch(exceptionInfo.ExceptionType)
{
// Could not access memory. subcode contains the bad memory address.
case EXC_BAD_ACCESS:
if (exceptionInfo.SubcodeCount != 2)
{
NONPAL_RETAIL_ASSERT("Got an unexpected subcode");
exceptionCode = EXCEPTION_ILLEGAL_INSTRUCTION;
}
else
{
#if defined(__amd64__)
exceptionCode = EXCEPTION_ACCESS_VIOLATION;
#elif defined(_ARM64_)
switch (exceptionInfo.Subcodes[0])
{
case EXC_ARM_DA_ALIGN:
exceptionCode = EXCEPTION_DATATYPE_MISALIGNMENT;
break;
case EXC_ARM_DA_DEBUG:
exceptionCode = EXCEPTION_BREAKPOINT;
break;
case EXC_ARM_SP_ALIGN:
exceptionCode = EXCEPTION_DATATYPE_MISALIGNMENT;
break;
case EXC_ARM_SWP:
exceptionCode = EXCEPTION_ILLEGAL_INSTRUCTION;
break;
case EXC_ARM_PAC_FAIL:
// PAC Authentication failure fall through
default:
exceptionCode = EXCEPTION_ACCESS_VIOLATION;
}
#else
#error Unexpected architecture
#endif
pExceptionRecord->NumberParameters = 2;
pExceptionRecord->ExceptionInformation[0] = 0;
pExceptionRecord->ExceptionInformation[1] = exceptionInfo.Subcodes[1];
NONPAL_TRACE("subcodes[1] = %llx\n", (uint64_t) exceptionInfo.Subcodes[1]);
}
break;
// Instruction failed. Illegal or undefined instruction or operand.
case EXC_BAD_INSTRUCTION :
// TODO: Identify privileged instruction. Need to get the thread state and read the machine code. May
// be better to do this in the place that calls SEHProcessException, similar to how it's done on Linux.
exceptionCode = EXCEPTION_ILLEGAL_INSTRUCTION;
break;
// Arithmetic exception; exact nature of exception is in subcode field.
case EXC_ARITHMETIC:
if (exceptionInfo.SubcodeCount != 2)
{
NONPAL_RETAIL_ASSERT("Got an unexpected subcode");
exceptionCode = EXCEPTION_ILLEGAL_INSTRUCTION;
}
else
{
switch (exceptionInfo.Subcodes[0])
{
#if defined(__amd64__)
case EXC_I386_DIV:
exceptionCode = EXCEPTION_INT_DIVIDE_BY_ZERO;
break;
case EXC_I386_INTO:
exceptionCode = EXCEPTION_INT_OVERFLOW;
break;
case EXC_I386_EXTOVR:
exceptionCode = EXCEPTION_FLT_OVERFLOW;
break;
case EXC_I386_BOUND:
exceptionCode = EXCEPTION_ARRAY_BOUNDS_EXCEEDED;
break;
#elif defined(_ARM64_)
case EXC_ARM_FP_IO:
exceptionCode = EXCEPTION_FLT_INVALID_OPERATION;
break;
case EXC_ARM_FP_DZ:
exceptionCode = EXCEPTION_FLT_DIVIDE_BY_ZERO;
break;
case EXC_ARM_FP_OF:
exceptionCode = EXCEPTION_FLT_OVERFLOW;
break;
case EXC_ARM_FP_UF:
exceptionCode = EXCEPTION_FLT_UNDERFLOW;
break;
case EXC_ARM_FP_IX:
exceptionCode = EXCEPTION_FLT_INEXACT_RESULT;
break;
case EXC_ARM_FP_ID:
exceptionCode = EXCEPTION_FLT_DENORMAL_OPERAND;
break;
#else
#error Unexpected architecture
#endif
default:
exceptionCode = EXCEPTION_ILLEGAL_INSTRUCTION;
break;
}
}
break;
case EXC_SOFTWARE:
exceptionCode = EXCEPTION_ILLEGAL_INSTRUCTION;
break;
// Trace, breakpoint, etc. Details in subcode field.
case EXC_BREAKPOINT:
#if defined(__amd64__)
if (exceptionInfo.Subcodes[0] == EXC_I386_SGL)
{
exceptionCode = EXCEPTION_SINGLE_STEP;
}
else if (exceptionInfo.Subcodes[0] == EXC_I386_BPT)
{
exceptionCode = EXCEPTION_BREAKPOINT;
}
#elif defined(_ARM64_)
if (exceptionInfo.Subcodes[0] == EXC_ARM_BREAKPOINT)
{
exceptionCode = EXCEPTION_BREAKPOINT;
}
#else
#error Unexpected architecture
#endif
else
{
WARN("unexpected subcode %d for EXC_BREAKPOINT", exceptionInfo.Subcodes[0]);
exceptionCode = EXCEPTION_BREAKPOINT;
}
break;
// System call requested. Details in subcode field.
case EXC_SYSCALL:
exceptionCode = EXCEPTION_ILLEGAL_INSTRUCTION;
break;
// System call with a number in the Mach call range requested. Details in subcode field.
case EXC_MACH_SYSCALL:
exceptionCode = EXCEPTION_ILLEGAL_INSTRUCTION;
break;
default:
NONPAL_ASSERT("Got unknown trap code %d\n", exceptionInfo.ExceptionType);
break;
}
pExceptionRecord->ExceptionCode = exceptionCode;
}
#ifdef _DEBUG
const char *
GetExceptionString(
exception_type_t exception
)
{
switch(exception)
{
case EXC_BAD_ACCESS:
return "EXC_BAD_ACCESS";
case EXC_BAD_INSTRUCTION:
return "EXC_BAD_INSTRUCTION";
case EXC_ARITHMETIC:
return "EXC_ARITHMETIC";
case EXC_SOFTWARE:
return "EXC_SOFTWARE";
case EXC_BREAKPOINT:
return "EXC_BREAKPOINT";
case EXC_SYSCALL:
return "EXC_SYSCALL";
case EXC_MACH_SYSCALL:
return "EXC_MACH_SYSCALL";
default:
NONPAL_ASSERT("Got unknown trap code %d\n", exception);
break;
}
return "INVALID CODE";
}
#endif // _DEBUG
/*++
Function :
HijackFaultingThread
Sets the faulting thread up to return to PAL_DispatchException with an
ExceptionRecord and thread CONTEXT.
Parameters:
thread - thread the exception happened
task - task the exception happened
message - exception message
Return value :
None
--*/
static
void
HijackFaultingThread(
mach_port_t thread, // [in] thread the exception happened on
mach_port_t task, // [in] task the exception happened on
MachMessage& message) // [in] exception message
{
MachExceptionInfo exceptionInfo(thread, message);
EXCEPTION_RECORD exceptionRecord;
CONTEXT threadContext;
kern_return_t machret;
// Fill in the exception record from the exception info
BuildExceptionRecord(exceptionInfo, &exceptionRecord);
#if defined(__amd64__)
threadContext.ContextFlags = CONTEXT_FLOATING_POINT;
CONTEXT_GetThreadContextFromThreadState(x86_FLOAT_STATE, (thread_state_t)&exceptionInfo.FloatState, &threadContext);
threadContext.ContextFlags |= CONTEXT_CONTROL | CONTEXT_INTEGER | CONTEXT_SEGMENTS;
CONTEXT_GetThreadContextFromThreadState(x86_THREAD_STATE, (thread_state_t)&exceptionInfo.ThreadState, &threadContext);
void **targetSP = (void **)threadContext.Rsp;
#elif defined(_ARM64_)
threadContext.ContextFlags = CONTEXT_FLOATING_POINT;
CONTEXT_GetThreadContextFromThreadState(ARM_NEON_STATE64, (thread_state_t)&exceptionInfo.FloatState, &threadContext);
threadContext.ContextFlags |= CONTEXT_CONTROL | CONTEXT_INTEGER;
CONTEXT_GetThreadContextFromThreadState(ARM_THREAD_STATE64, (thread_state_t)&exceptionInfo.ThreadState, &threadContext);
void **targetSP = (void **)threadContext.Sp;
#else
#error Unexpected architecture
#endif
// For CoreCLR we look more deeply at access violations to determine whether they're the result of a stack
// overflow. If so we'll terminate the process immediately (the current default policy of the CoreCLR EE).
// Otherwise we'll either A/V ourselves trying to set up the SEH exception record and context on the
// target thread's stack (unlike Windows there's no extra stack reservation to guarantee this can be done)
// or, and this the case we're trying to avoid, it's possible we'll succeed and the runtime will go ahead
// and process the SO like it was a simple AV. Since the runtime doesn't currently implement stack probing
// on non-Windows platforms, this could lead to data corruption (we have SO intolerant code in the runtime
// which manipulates global state under the assumption that an SO cannot occur due to a prior stack
// probe).
// Determining whether an AV is really an SO is not quite straightforward. We can get stack bounds
// information from pthreads but (a) we only have the target Mach thread port and no way to map to a
// pthread easily and (b) the pthread functions lie about the bounds on the main thread.
// Instead we inspect the target thread SP we just retrieved above and compare it with the AV address. If
// they both lie in the same page or the SP is at a higher address than the AV but in the same VM region,
// then we'll consider the AV to be an SO. Note that we can't assume that SP will be in the same page as
// the AV on an SO, even though we force GCC to generate stack probes on stack extension (-fstack-check).
// That's because GCC currently generates the probe *before* altering SP. Since a given stack extension can
// involve multiple pages and GCC generates all the required probes before updating SP in a single
// operation, the faulting probe can be at an address that is far removed from the thread's current value
// of SP.
// In the case where the AV and SP aren't in the same or adjacent pages we check if the first page
// following the faulting address belongs in the same VM region as the current value of SP. Since all pages
// in a VM region have the same attributes this check eliminates the possibility that there's another guard
// page in the range between the fault and the SP, effectively establishing that the AV occurred in the
// guard page associated with the stack associated with the SP.
// We are assuming here that thread stacks are always allocated in a single VM region. I've seen no
// evidence thus far that this is not the case (and the mere fact we rely on Mach apis already puts us on
// brittle ground anyway).
// (a) SP always marks the current limit of the stack (in that all valid stack accesses will be of
// the form [SP + delta]). The Mac x86 ABI appears to guarantee this (or rather it does not
// guarantee that stack slots below SP will not be invalidated by asynchronous events such as
// interrupts, which mostly amounts to the same thing for user mode code). Note that the Mac PPC
// ABI does allow some (constrained) access below SP, but we're not currently supporting this
// platform.
// (b) All code will extend the stack "carefully" (by which we mean that stack extensions of more
// than one page in size will touch at least one byte in each intervening page (in decreasing
// address order), to guarantee that the guard page is hit before memory beyond the guard page is
// corrupted). Our managed jits always generate code which does this as does MSVC. GCC, however,
// does not do this by default. We have to explicitly provide the -fstack-check compiler option
// to enable the behavior.
// Assume that AV isn't an SO to begin with.
bool fIsStackOverflow = false;
if (exceptionRecord.ExceptionCode == EXCEPTION_ACCESS_VIOLATION)
{
// Calculate the page base addresses for the fault and the faulting thread's SP.
int cbPage = getpagesize();
char *pFaultPage = (char*)(exceptionRecord.ExceptionInformation[1] & ~(cbPage - 1));
char *pStackTopPage = (char*)((size_t)targetSP & ~(cbPage - 1));
if (pFaultPage == pStackTopPage || pFaultPage == (pStackTopPage - cbPage))
{
// The easy case is when the AV occurred in the same or adjacent page as the stack pointer.
fIsStackOverflow = true;
}
else if (pFaultPage < pStackTopPage)
{
// Calculate the address of the page immediately following the fault and check that it
// lies in the same VM region as the stack pointer.
vm_address_t vm_address;
vm_size_t vm_size;
vm_region_flavor_t vm_flavor;
mach_msg_type_number_t infoCnt;
vm_region_basic_info_data_64_t info;
infoCnt = VM_REGION_BASIC_INFO_COUNT_64;
vm_flavor = VM_REGION_BASIC_INFO_64;
mach_port_t object_name;
vm_address = (vm_address_t)(pFaultPage + cbPage);
machret = vm_region_64(
mach_task_self(),
&vm_address,
&vm_size,
vm_flavor,
(vm_region_info_t)&info,
&infoCnt,
&object_name);
CHECK_MACH("vm_region_64", machret);
// If vm_region updated the address we gave it then that address was not part of a region at all
// (and so this cannot be an SO). Otherwise check that the ESP lies in the region returned.
char *pRegionStart = (char*)vm_address;
char *pRegionEnd = (char*)vm_address + vm_size;
if (pRegionStart == (pFaultPage + cbPage) && pStackTopPage < pRegionEnd)
fIsStackOverflow = true;
}
if (!fIsStackOverflow)
{
// Check if we can read pointer sizeD bytes below the target thread's stack pointer.
// If we are unable to, then it implies we have run into SO.
vm_address_t targetAddr = (mach_vm_address_t)(targetSP);
targetAddr -= sizeof(void *);
vm_size_t vm_size = sizeof(void *);
char arr[8];
vm_size_t data_count = 8;
machret = vm_read_overwrite(mach_task_self(), targetAddr, vm_size, (pointer_t)arr, &data_count);
if (machret == KERN_INVALID_ADDRESS)
{
fIsStackOverflow = true;
}
}
}
if (fIsStackOverflow)
{
exceptionRecord.ExceptionCode = EXCEPTION_STACK_OVERFLOW;
}
exceptionRecord.ExceptionFlags = EXCEPTION_IS_SIGNAL;
exceptionRecord.ExceptionRecord = NULL;
#if defined(__amd64__)
NONPAL_ASSERTE(exceptionInfo.ThreadState.tsh.flavor == x86_THREAD_STATE64);
// Make a copy of the thread state because the one in exceptionInfo needs to be preserved to restore
// the state if the exception is forwarded.
x86_thread_state64_t ts64 = exceptionInfo.ThreadState.uts.ts64;
// If we're in single step mode, disable it since we're going to call PAL_DispatchException
if (exceptionRecord.ExceptionCode == EXCEPTION_SINGLE_STEP)
{
ts64.__rflags &= ~EFL_TF;
}
exceptionRecord.ExceptionAddress = (void *)ts64.__rip;
void **FramePointer = (void **)ts64.__rsp;
#elif defined(_ARM64_)
// Make a copy of the thread state because the one in exceptionInfo needs to be preserved to restore
// the state if the exception is forwarded.
arm_thread_state64_t ts64 = exceptionInfo.ThreadState;
exceptionRecord.ExceptionAddress = (void *)arm_thread_state64_get_pc_fptr(ts64);
void **FramePointer = (void **)arm_thread_state64_get_sp(ts64);
#else
#error Unexpected architecture
#endif
if (fIsStackOverflow)
{
// Allocate the minimal stack necessary for handling stack overflow
int stackOverflowStackSize = 7 * 4096;
// Align the size to virtual page size and add one virtual page as a stack guard
stackOverflowStackSize = ALIGN_UP(stackOverflowStackSize, VIRTUAL_PAGE_SIZE) + VIRTUAL_PAGE_SIZE;
void* stackOverflowHandlerStack = mmap(NULL, stackOverflowStackSize, PROT_READ | PROT_WRITE, MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
if ((stackOverflowHandlerStack == MAP_FAILED) || mprotect((void*)stackOverflowHandlerStack, VIRTUAL_PAGE_SIZE, PROT_NONE) != 0)
{
// We are out of memory or we've failed to protect the guard page, so resort to just printing a stack overflow message and abort
write(STDERR_FILENO, StackOverflowMessage, sizeof(StackOverflowMessage) - 1);
abort();
}
FramePointer = (void**)((size_t)stackOverflowHandlerStack + stackOverflowStackSize);
}
// Construct a stack frame for a pretend activation of the function
// PAL_DispatchExceptionWrapper that serves only to make the stack
// correctly unwindable by the system exception unwinder.
// PAL_DispatchExceptionWrapper has an ebp frame, its local variables
// are the context and exception record, and it has just "called"
// PAL_DispatchException.
#if defined(__amd64__)
*--FramePointer = (void *)ts64.__rip;
*--FramePointer = (void *)ts64.__rbp;
ts64.__rbp = (SIZE_T)FramePointer;
#elif defined(_ARM64_)
*--FramePointer = (void *)arm_thread_state64_get_pc_fptr(ts64);
*--FramePointer = (void *)arm_thread_state64_get_fp(ts64);
arm_thread_state64_set_fp(ts64, FramePointer);
#else
#error Unexpected architecture
#endif
// Put the context on the stack
FramePointer = (void **)((ULONG_PTR)FramePointer - sizeof(CONTEXT));
// Make sure it's aligned - CONTEXT has 16-byte alignment
FramePointer = (void **)((ULONG_PTR)FramePointer - ((ULONG_PTR)FramePointer % 16));
CONTEXT *pContext = (CONTEXT *)FramePointer;
*pContext = threadContext;
// Put the exception record on the stack
FramePointer = (void **)((ULONG_PTR)FramePointer - sizeof(EXCEPTION_RECORD));
EXCEPTION_RECORD *pExceptionRecord = (EXCEPTION_RECORD *)FramePointer;
*pExceptionRecord = exceptionRecord;
FramePointer = (void **)((ULONG_PTR)FramePointer - sizeof(MachExceptionInfo));
MachExceptionInfo *pMachExceptionInfo = (MachExceptionInfo *)FramePointer;
*pMachExceptionInfo = exceptionInfo;
#if defined(__amd64__)
// Push arguments to PAL_DispatchException
FramePointer = (void **)((ULONG_PTR)FramePointer - 3 * sizeof(void *));
// Make sure it's aligned - ABI requires 16-byte alignment
FramePointer = (void **)((ULONG_PTR)FramePointer - ((ULONG_PTR)FramePointer % 16));
FramePointer[0] = pContext;
FramePointer[1] = pExceptionRecord;
FramePointer[2] = pMachExceptionInfo;
// Place the return address to right after the fake call in PAL_DispatchExceptionWrapper
FramePointer[-1] = (void *)((ULONG_PTR)PAL_DispatchExceptionWrapper + PAL_DispatchExceptionReturnOffset);
// Make the instruction register point to DispatchException
ts64.__rip = (SIZE_T)PAL_DispatchException;
ts64.__rsp = (SIZE_T)&FramePointer[-1]; // skip return address
// Now set the thread state for the faulting thread so that PAL_DispatchException executes next
machret = thread_set_state(thread, x86_THREAD_STATE64, (thread_state_t)&ts64, x86_THREAD_STATE64_COUNT);
CHECK_MACH("thread_set_state(thread)", machret);
#elif defined(_ARM64_)
// Setup arguments to PAL_DispatchException
ts64.__x[0] = (uint64_t)pContext;
ts64.__x[1] = (uint64_t)pExceptionRecord;
ts64.__x[2] = (uint64_t)pMachExceptionInfo;
// Make sure it's aligned - SP has 16-byte alignment
FramePointer = (void **)((ULONG_PTR)FramePointer - ((ULONG_PTR)FramePointer % 16));
arm_thread_state64_set_sp(ts64, FramePointer);
// Make the call to DispatchException
arm_thread_state64_set_lr_fptr(ts64, (uint64_t)PAL_DispatchExceptionWrapper + PAL_DispatchExceptionReturnOffset);
arm_thread_state64_set_pc_fptr(ts64, PAL_DispatchException);
// Now set the thread state for the faulting thread so that PAL_DispatchException executes next
machret = thread_set_state(thread, ARM_THREAD_STATE64, (thread_state_t)&ts64, ARM_THREAD_STATE64_COUNT);
CHECK_MACH("thread_set_state(thread)", machret);
#else
#error Unexpected architecture
#endif
}
/*++
Function :
SuspendMachThread
Suspend the specified thread.
Parameters:
thread - mach thread port
Return value :
KERN_SUCCESS if the suspend succeeded, other code in case of failure
--*/
static
kern_return_t
SuspendMachThread(thread_act_t thread)
{
kern_return_t machret;
while (true)
{
machret = thread_suspend(thread);
if (machret != KERN_SUCCESS)
{
break;
}
// Ensure that if the thread was running in the kernel, the kernel operation
// is safely aborted so that it can be restarted later.
machret = thread_abort_safely(thread);
if (machret == KERN_SUCCESS)
{
break;
}
// The thread was running in the kernel executing a non-atomic operation
// that cannot be restarted, so we need to resume the thread and retry
machret = thread_resume(thread);
if (machret != KERN_SUCCESS)
{
break;
}
}
return machret;
}
/*++
Function :
SEHExceptionThread
Entry point for the thread that will listen for exception in any other thread.
NOTE: This thread is not a PAL thread, and it must not be one. If it was,
exceptions on this thread would be delivered to the port this thread itself
is listening on.
In particular, if another thread overflows its stack, the exception handling
thread receives a message. It will try to create a PAL_DispatchException
frame on the faulting thread, which will likely fault. If the exception
processing thread is not a PAL thread, the process gets terminated with a
bus error; if the exception processing thread was a PAL thread, we would see
a hang (since no thread is listening for the exception message that gets sent).
Of the two ugly behaviors, the bus error is definitely favorable.
This means: no printf, no TRACE, no PAL allocation, no ExitProcess,
no LastError in this function and its helpers. To report fatal failure,
use NONPAL_RETAIL_ASSERT.
Parameters :
void *args - not used
Return value :
Never returns
--*/
void *
SEHExceptionThread(void *args)
{
ForwardedExceptionList feList;
MachMessage sReplyOrForward;
MachMessage sMessage;
kern_return_t machret;
thread_act_t thread;
// Loop processing incoming messages forever.
while (true)
{
// Receive the next message.
sMessage.Receive(s_ExceptionPort);
NONPAL_TRACE("Received message %s (%08x) from (remote) %08x to (local) %08x\n",
sMessage.GetMessageTypeName(),
sMessage.GetMessageType(),
sMessage.GetRemotePort(),
sMessage.GetLocalPort());
if (sMessage.IsSetThreadRequest())
{
// Handle a request to set the thread context for the specified target thread.
CONTEXT sContext;
thread = sMessage.GetThreadContext(&sContext);
// Suspend the target thread
machret = SuspendMachThread(thread);
CHECK_MACH("SuspendMachThread", machret);
machret = CONTEXT_SetThreadContextOnPort(thread, &sContext);
CHECK_MACH("CONTEXT_SetThreadContextOnPort", machret);
machret = thread_resume(thread);
CHECK_MACH("thread_resume", machret);
}
else if (sMessage.IsExceptionNotification())
{
// This is a notification of an exception occurring on another thread.
exception_type_t exceptionType = sMessage.GetException();
thread = sMessage.GetThread();
#ifdef _DEBUG
if (NONPAL_TRACE_ENABLED)
{
NONPAL_TRACE("ExceptionNotification %s (%u) thread %08x flavor %u\n",