-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Expand file tree
/
Copy pathfaulthandler.rs
More file actions
1333 lines (1151 loc) · 40.3 KB
/
faulthandler.rs
File metadata and controls
1333 lines (1151 loc) · 40.3 KB
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
pub(crate) use decl::module_def;
#[allow(static_mut_refs)] // TODO: group code only with static mut refs
#[pymodule(name = "faulthandler")]
mod decl {
use crate::vm::{
PyObjectRef, PyResult, VirtualMachine,
frame::Frame,
function::{ArgIntoFloat, OptionalArg},
};
use alloc::sync::Arc;
use core::sync::atomic::{AtomicBool, AtomicI32, Ordering};
use core::time::Duration;
use parking_lot::{Condvar, Mutex};
#[cfg(any(unix, windows))]
use rustpython_common::os::{get_errno, set_errno};
use std::thread;
/// fault_handler_t
#[cfg(unix)]
struct FaultHandler {
signum: libc::c_int,
enabled: bool,
name: &'static str,
previous: libc::sigaction,
}
#[cfg(windows)]
struct FaultHandler {
signum: libc::c_int,
enabled: bool,
name: &'static str,
previous: libc::sighandler_t,
}
#[cfg(unix)]
impl FaultHandler {
const fn new(signum: libc::c_int, name: &'static str) -> Self {
Self {
signum,
enabled: false,
name,
// SAFETY: sigaction is a C struct that can be zero-initialized
previous: unsafe { core::mem::zeroed() },
}
}
}
#[cfg(windows)]
impl FaultHandler {
const fn new(signum: libc::c_int, name: &'static str) -> Self {
Self {
signum,
enabled: false,
name,
previous: 0,
}
}
}
/// faulthandler_handlers[]
/// Number of fatal signals
#[cfg(unix)]
const FAULTHANDLER_NSIGNALS: usize = 5;
#[cfg(windows)]
const FAULTHANDLER_NSIGNALS: usize = 4;
// Signal handlers use mutable statics matching faulthandler.c implementation.
#[cfg(unix)]
static mut FAULTHANDLER_HANDLERS: [FaultHandler; FAULTHANDLER_NSIGNALS] = [
FaultHandler::new(libc::SIGBUS, "Bus error"),
FaultHandler::new(libc::SIGILL, "Illegal instruction"),
FaultHandler::new(libc::SIGFPE, "Floating-point exception"),
FaultHandler::new(libc::SIGABRT, "Aborted"),
FaultHandler::new(libc::SIGSEGV, "Segmentation fault"),
];
#[cfg(windows)]
static mut FAULTHANDLER_HANDLERS: [FaultHandler; FAULTHANDLER_NSIGNALS] = [
FaultHandler::new(libc::SIGILL, "Illegal instruction"),
FaultHandler::new(libc::SIGFPE, "Floating-point exception"),
FaultHandler::new(libc::SIGABRT, "Aborted"),
FaultHandler::new(libc::SIGSEGV, "Segmentation fault"),
];
/// fatal_error state
struct FatalErrorState {
enabled: AtomicBool,
fd: AtomicI32,
all_threads: AtomicBool,
}
static FATAL_ERROR: FatalErrorState = FatalErrorState {
enabled: AtomicBool::new(false),
fd: AtomicI32::new(2), // stderr by default
all_threads: AtomicBool::new(true),
};
#[cfg(feature = "threading")]
type ThreadFrameSlot = Arc<rustpython_vm::vm::thread::ThreadSlot>;
// Watchdog thread state for dump_traceback_later
struct WatchdogState {
cancel: bool,
fd: i32,
timeout_us: u64,
repeat: bool,
exit: bool,
header: String,
#[cfg(feature = "threading")]
thread_frame_slots: Vec<(u64, ThreadFrameSlot)>,
}
type WatchdogHandle = Arc<(Mutex<WatchdogState>, Condvar)>;
static WATCHDOG: Mutex<Option<WatchdogHandle>> = Mutex::new(None);
// Signal-safe output functions
// PUTS macro
#[cfg(any(unix, windows))]
fn puts(fd: i32, s: &str) {
let _ = unsafe {
#[cfg(windows)]
{
libc::write(fd, s.as_ptr() as *const libc::c_void, s.len() as u32)
}
#[cfg(not(windows))]
{
libc::write(fd, s.as_ptr() as *const libc::c_void, s.len())
}
};
}
#[cfg(any(unix, windows))]
fn puts_bytes(fd: i32, s: &[u8]) {
let _ = unsafe {
#[cfg(windows)]
{
libc::write(fd, s.as_ptr() as *const libc::c_void, s.len() as u32)
}
#[cfg(not(windows))]
{
libc::write(fd, s.as_ptr() as *const libc::c_void, s.len())
}
};
}
// _Py_DumpHexadecimal (traceback.c)
#[cfg(any(unix, windows))]
fn dump_hexadecimal(fd: i32, value: u64, width: usize) {
const HEX_CHARS: &[u8; 16] = b"0123456789abcdef";
let mut buf = [0u8; 18]; // "0x" + 16 hex digits
buf[0] = b'0';
buf[1] = b'x';
for i in 0..width {
let digit = ((value >> (4 * (width - 1 - i))) & 0xf) as usize;
buf[2 + i] = HEX_CHARS[digit];
}
let _ = unsafe {
#[cfg(windows)]
{
libc::write(fd, buf.as_ptr() as *const libc::c_void, (2 + width) as u32)
}
#[cfg(not(windows))]
{
libc::write(fd, buf.as_ptr() as *const libc::c_void, 2 + width)
}
};
}
// _Py_DumpDecimal (traceback.c)
#[cfg(any(unix, windows))]
fn dump_decimal(fd: i32, value: usize) {
let mut buf = [0u8; 20];
let mut v = value;
let mut i = buf.len();
if v == 0 {
puts(fd, "0");
return;
}
while v > 0 {
i -= 1;
buf[i] = b'0' + (v % 10) as u8;
v /= 10;
}
let len = buf.len() - i;
let _ = unsafe {
#[cfg(windows)]
{
libc::write(fd, buf[i..].as_ptr() as *const libc::c_void, len as u32)
}
#[cfg(not(windows))]
{
libc::write(fd, buf[i..].as_ptr() as *const libc::c_void, len)
}
};
}
/// Get current thread ID
#[cfg(unix)]
fn current_thread_id() -> u64 {
unsafe { libc::pthread_self() as u64 }
}
#[cfg(windows)]
fn current_thread_id() -> u64 {
unsafe { windows_sys::Win32::System::Threading::GetCurrentThreadId() as u64 }
}
// write_thread_id (traceback.c:1240-1256)
#[cfg(any(unix, windows))]
fn write_thread_id(fd: i32, thread_id: u64, is_current: bool) {
if is_current {
puts(fd, "Current thread ");
} else {
puts(fd, "Thread ");
}
dump_hexadecimal(fd, thread_id, core::mem::size_of::<usize>() * 2);
puts(fd, " (most recent call first):\n");
}
/// Dump the current thread's live frame chain to fd (signal-safe).
/// Walks the `Frame.previous` pointer chain starting from the
/// thread-local current frame pointer.
#[cfg(any(unix, windows))]
fn dump_live_frames(fd: i32) {
const MAX_FRAME_DEPTH: usize = 100;
let mut frame_ptr = crate::vm::vm::thread::get_current_frame();
if frame_ptr.is_null() {
puts(fd, " <no Python frame>\n");
return;
}
let mut depth = 0;
while !frame_ptr.is_null() && depth < MAX_FRAME_DEPTH {
let frame = unsafe { &*frame_ptr };
dump_frame_from_raw(fd, frame);
frame_ptr = frame.previous_frame();
depth += 1;
}
if depth >= MAX_FRAME_DEPTH && !frame_ptr.is_null() {
puts(fd, " ...\n");
}
}
/// Dump a single frame's info to fd (signal-safe), reading live data.
#[cfg(any(unix, windows))]
fn dump_frame_from_raw(fd: i32, frame: &Frame) {
let filename = frame.code.source_path().as_str();
let funcname = frame.code.obj_name.as_str();
let lasti = frame.lasti();
let lineno = if lasti == 0 {
frame.code.first_line_number.map(|n| n.get()).unwrap_or(1) as u32
} else {
let idx = (lasti as usize).saturating_sub(1);
if idx < frame.code.locations.len() {
frame.code.locations[idx].0.line.get() as u32
} else {
frame.code.first_line_number.map(|n| n.get()).unwrap_or(0) as u32
}
};
puts(fd, " File \"");
dump_ascii(fd, filename);
puts(fd, "\", line ");
dump_decimal(fd, lineno as usize);
puts(fd, " in ");
dump_ascii(fd, funcname);
puts(fd, "\n");
}
// faulthandler_dump_traceback (signal-safe, for fatal errors)
#[cfg(any(unix, windows))]
fn faulthandler_dump_traceback(fd: i32, all_threads: bool) {
static REENTRANT: AtomicBool = AtomicBool::new(false);
if REENTRANT.swap(true, Ordering::SeqCst) {
return;
}
// Write thread header
if all_threads {
write_thread_id(fd, current_thread_id(), true);
} else {
puts(fd, "Stack (most recent call first):\n");
}
dump_live_frames(fd);
REENTRANT.store(false, Ordering::SeqCst);
}
/// MAX_STRING_LENGTH in traceback.c
const MAX_STRING_LENGTH: usize = 500;
/// Truncate a UTF-8 string to at most `max_bytes` without splitting a
/// multi-byte codepoint. Signal-safe (no allocation, no panic).
#[cfg(any(unix, windows))]
fn safe_truncate(s: &str, max_bytes: usize) -> (&str, bool) {
if s.len() <= max_bytes {
return (s, false);
}
let mut end = max_bytes;
while end > 0 && !s.is_char_boundary(end) {
end -= 1;
}
(&s[..end], true)
}
/// Write a string to fd, truncating with "..." if it exceeds MAX_STRING_LENGTH.
/// Mirrors `_Py_DumpASCII` truncation behavior.
#[cfg(any(unix, windows))]
fn dump_ascii(fd: i32, s: &str) {
let (truncated_s, was_truncated) = safe_truncate(s, MAX_STRING_LENGTH);
puts(fd, truncated_s);
if was_truncated {
puts(fd, "...");
}
}
/// Write a frame's info to an fd using signal-safe I/O.
#[cfg(any(unix, windows))]
fn dump_frame_from_ref(fd: i32, frame: &crate::vm::Py<Frame>) {
let funcname = frame.code.obj_name.as_str();
let filename = frame.code.source_path().as_str();
let lineno = if frame.lasti() == 0 {
frame.code.first_line_number.map(|n| n.get()).unwrap_or(1) as u32
} else {
frame.current_location().line.get() as u32
};
puts(fd, " File \"");
dump_ascii(fd, filename);
puts(fd, "\", line ");
dump_decimal(fd, lineno as usize);
puts(fd, " in ");
dump_ascii(fd, funcname);
puts(fd, "\n");
}
/// Dump traceback for a thread given its frame stack (for cross-thread dumping).
/// # Safety
/// Each `FramePtr` must point to a live frame (caller holds the Mutex).
#[cfg(all(any(unix, windows), feature = "threading"))]
fn dump_traceback_thread_frames(
fd: i32,
thread_id: u64,
is_current: bool,
frames: &[rustpython_vm::vm::FramePtr],
) {
write_thread_id(fd, thread_id, is_current);
if frames.is_empty() {
puts(fd, " <no Python frame>\n");
} else {
for fp in frames.iter().rev() {
// SAFETY: caller holds the Mutex, so the owning thread can't pop.
dump_frame_from_ref(fd, unsafe { fp.as_ref() });
}
}
}
#[derive(FromArgs)]
struct DumpTracebackArgs {
#[pyarg(any, default)]
file: OptionalArg<PyObjectRef>,
#[pyarg(any, default = true)]
all_threads: bool,
}
#[pyfunction]
fn dump_traceback(args: DumpTracebackArgs, vm: &VirtualMachine) -> PyResult<()> {
let fd = get_fd_from_file_opt(args.file, vm)?;
#[cfg(any(unix, windows))]
{
if args.all_threads {
dump_all_threads(fd, vm);
} else {
puts(fd, "Stack (most recent call first):\n");
let frames = vm.frames.borrow();
for fp in frames.iter().rev() {
// SAFETY: the frame is alive while it's in the Vec
dump_frame_from_ref(fd, unsafe { fp.as_ref() });
}
}
}
#[cfg(not(any(unix, windows)))]
{
let _ = (fd, args.all_threads);
}
Ok(())
}
/// Dump tracebacks of all threads.
#[cfg(any(unix, windows))]
fn dump_all_threads(fd: i32, vm: &VirtualMachine) {
// Get all threads' frame stacks from the shared registry
#[cfg(feature = "threading")]
{
let current_tid = rustpython_vm::stdlib::_thread::get_ident();
let registry = vm.state.thread_frames.lock();
// First dump non-current threads, then current thread last
for (&tid, slot) in registry.iter() {
if tid == current_tid {
continue;
}
let frames_guard = slot.frames.lock();
dump_traceback_thread_frames(fd, tid, false, &frames_guard);
puts(fd, "\n");
}
// Now dump current thread (use vm.frames for most up-to-date data)
write_thread_id(fd, current_tid, true);
let frames = vm.frames.borrow();
if frames.is_empty() {
puts(fd, " <no Python frame>\n");
} else {
for fp in frames.iter().rev() {
dump_frame_from_ref(fd, unsafe { fp.as_ref() });
}
}
}
#[cfg(not(feature = "threading"))]
{
write_thread_id(fd, current_thread_id(), true);
let frames = vm.frames.borrow();
for fp in frames.iter().rev() {
dump_frame_from_ref(fd, unsafe { fp.as_ref() });
}
}
}
#[derive(FromArgs)]
#[allow(unused)]
struct EnableArgs {
#[pyarg(any, default)]
file: OptionalArg<PyObjectRef>,
#[pyarg(any, default = true)]
all_threads: bool,
}
// faulthandler_py_enable
#[pyfunction]
fn enable(args: EnableArgs, vm: &VirtualMachine) -> PyResult<()> {
// Get file descriptor
let fd = get_fd_from_file_opt(args.file, vm)?;
// Store fd and all_threads in global state
FATAL_ERROR.fd.store(fd, Ordering::Relaxed);
FATAL_ERROR
.all_threads
.store(args.all_threads, Ordering::Relaxed);
// Install signal handlers
if !faulthandler_enable_internal() {
return Err(vm.new_runtime_error("Failed to enable faulthandler"));
}
Ok(())
}
// Signal handlers
/// faulthandler_disable_fatal_handler (faulthandler.c:310-321)
#[cfg(unix)]
unsafe fn faulthandler_disable_fatal_handler(handler: &mut FaultHandler) {
if !handler.enabled {
return;
}
handler.enabled = false;
unsafe {
libc::sigaction(handler.signum, &handler.previous, core::ptr::null_mut());
}
}
#[cfg(windows)]
unsafe fn faulthandler_disable_fatal_handler(handler: &mut FaultHandler) {
if !handler.enabled {
return;
}
handler.enabled = false;
unsafe {
libc::signal(handler.signum, handler.previous);
}
}
// faulthandler_fatal_error
#[cfg(unix)]
extern "C" fn faulthandler_fatal_error(signum: libc::c_int) {
let save_errno = get_errno();
if !FATAL_ERROR.enabled.load(Ordering::Relaxed) {
return;
}
let fd = FATAL_ERROR.fd.load(Ordering::Relaxed);
let handler = unsafe {
FAULTHANDLER_HANDLERS
.iter_mut()
.find(|h| h.signum == signum)
};
if let Some(h) = handler {
// Disable handler (restores previous)
unsafe {
faulthandler_disable_fatal_handler(h);
}
puts(fd, "Fatal Python error: ");
puts(fd, h.name);
puts(fd, "\n\n");
} else {
puts(fd, "Fatal Python error from unexpected signum: ");
dump_decimal(fd, signum as usize);
puts(fd, "\n\n");
}
let all_threads = FATAL_ERROR.all_threads.load(Ordering::Relaxed);
faulthandler_dump_traceback(fd, all_threads);
set_errno(save_errno);
// Reset to default handler and re-raise to ensure process terminates.
// We cannot just restore the previous handler because Rust's runtime
// may have installed its own SIGSEGV handler (for stack overflow detection)
// that doesn't terminate the process on software-raised signals.
unsafe {
libc::signal(signum, libc::SIG_DFL);
libc::raise(signum);
}
// Fallback if raise() somehow didn't terminate the process
unsafe {
libc::_exit(1);
}
}
// faulthandler_fatal_error for Windows
#[cfg(windows)]
extern "C" fn faulthandler_fatal_error(signum: libc::c_int) {
let save_errno = get_errno();
if !FATAL_ERROR.enabled.load(Ordering::Relaxed) {
return;
}
let fd = FATAL_ERROR.fd.load(Ordering::Relaxed);
let handler = unsafe {
FAULTHANDLER_HANDLERS
.iter_mut()
.find(|h| h.signum == signum)
};
if let Some(h) = handler {
unsafe {
faulthandler_disable_fatal_handler(h);
}
puts(fd, "Fatal Python error: ");
puts(fd, h.name);
puts(fd, "\n\n");
} else {
puts(fd, "Fatal Python error from unexpected signum: ");
dump_decimal(fd, signum as usize);
puts(fd, "\n\n");
}
let all_threads = FATAL_ERROR.all_threads.load(Ordering::Relaxed);
faulthandler_dump_traceback(fd, all_threads);
set_errno(save_errno);
unsafe {
libc::signal(signum, libc::SIG_DFL);
libc::raise(signum);
}
// Fallback
std::process::exit(1);
}
// Windows vectored exception handler (faulthandler.c:417-480)
#[cfg(windows)]
static EXC_HANDLER: core::sync::atomic::AtomicUsize = core::sync::atomic::AtomicUsize::new(0);
#[cfg(windows)]
fn faulthandler_ignore_exception(code: u32) -> bool {
// bpo-30557: ignore exceptions which are not errors
if (code & 0x80000000) == 0 {
return true;
}
// bpo-31701: ignore MSC and COM exceptions
if code == 0xE06D7363 || code == 0xE0434352 {
return true;
}
false
}
#[cfg(windows)]
unsafe extern "system" fn faulthandler_exc_handler(
exc_info: *mut windows_sys::Win32::System::Diagnostics::Debug::EXCEPTION_POINTERS,
) -> i32 {
const EXCEPTION_CONTINUE_SEARCH: i32 = 0;
if !FATAL_ERROR.enabled.load(Ordering::Relaxed) {
return EXCEPTION_CONTINUE_SEARCH;
}
let record = unsafe { &*(*exc_info).ExceptionRecord };
let code = record.ExceptionCode as u32;
if faulthandler_ignore_exception(code) {
return EXCEPTION_CONTINUE_SEARCH;
}
let fd = FATAL_ERROR.fd.load(Ordering::Relaxed);
puts(fd, "Windows fatal exception: ");
match code {
0xC0000005 => puts(fd, "access violation"),
0xC000008C => puts(fd, "float divide by zero"),
0xC0000091 => puts(fd, "float overflow"),
0xC0000094 => puts(fd, "int divide by zero"),
0xC0000095 => puts(fd, "integer overflow"),
0xC0000006 => puts(fd, "page error"),
0xC00000FD => puts(fd, "stack overflow"),
0xC000001D => puts(fd, "illegal instruction"),
_ => {
puts(fd, "code ");
dump_hexadecimal(fd, code as u64, 8);
}
}
puts(fd, "\n\n");
// Disable SIGSEGV handler for access violations to avoid double output
if code == 0xC0000005 {
unsafe {
for handler in FAULTHANDLER_HANDLERS.iter_mut() {
if handler.signum == libc::SIGSEGV {
faulthandler_disable_fatal_handler(handler);
break;
}
}
}
}
let all_threads = FATAL_ERROR.all_threads.load(Ordering::Relaxed);
faulthandler_dump_traceback(fd, all_threads);
EXCEPTION_CONTINUE_SEARCH
}
// faulthandler_enable
#[cfg(unix)]
fn faulthandler_enable_internal() -> bool {
if FATAL_ERROR.enabled.load(Ordering::Relaxed) {
return true;
}
unsafe {
for handler in FAULTHANDLER_HANDLERS.iter_mut() {
if handler.enabled {
continue;
}
let mut action: libc::sigaction = core::mem::zeroed();
action.sa_sigaction = faulthandler_fatal_error as *const () as libc::sighandler_t;
// SA_NODEFER flag
action.sa_flags = libc::SA_NODEFER;
if libc::sigaction(handler.signum, &action, &mut handler.previous) != 0 {
return false;
}
handler.enabled = true;
}
}
FATAL_ERROR.enabled.store(true, Ordering::Relaxed);
true
}
#[cfg(windows)]
fn faulthandler_enable_internal() -> bool {
if FATAL_ERROR.enabled.load(Ordering::Relaxed) {
return true;
}
unsafe {
for handler in FAULTHANDLER_HANDLERS.iter_mut() {
if handler.enabled {
continue;
}
handler.previous = libc::signal(
handler.signum,
faulthandler_fatal_error as *const () as libc::sighandler_t,
);
// SIG_ERR is -1 as sighandler_t (which is usize on Windows)
if handler.previous == libc::SIG_ERR as libc::sighandler_t {
return false;
}
handler.enabled = true;
}
}
// Register Windows vectored exception handler
#[cfg(windows)]
{
use windows_sys::Win32::System::Diagnostics::Debug::AddVectoredExceptionHandler;
let h = unsafe { AddVectoredExceptionHandler(1, Some(faulthandler_exc_handler)) };
EXC_HANDLER.store(h as usize, Ordering::Relaxed);
}
FATAL_ERROR.enabled.store(true, Ordering::Relaxed);
true
}
// faulthandler_disable
#[cfg(any(unix, windows))]
fn faulthandler_disable_internal() {
if !FATAL_ERROR.enabled.swap(false, Ordering::Relaxed) {
return;
}
unsafe {
for handler in FAULTHANDLER_HANDLERS.iter_mut() {
faulthandler_disable_fatal_handler(handler);
}
}
// Remove Windows vectored exception handler
#[cfg(windows)]
{
use windows_sys::Win32::System::Diagnostics::Debug::RemoveVectoredExceptionHandler;
let h = EXC_HANDLER.swap(0, Ordering::Relaxed);
if h != 0 {
unsafe {
RemoveVectoredExceptionHandler(h as *mut core::ffi::c_void);
}
}
}
}
#[cfg(not(any(unix, windows)))]
fn faulthandler_enable_internal() -> bool {
FATAL_ERROR.enabled.store(true, Ordering::Relaxed);
true
}
#[cfg(not(any(unix, windows)))]
fn faulthandler_disable_internal() {
FATAL_ERROR.enabled.store(false, Ordering::Relaxed);
}
// faulthandler_disable_py
#[pyfunction]
fn disable() -> bool {
let was_enabled = FATAL_ERROR.enabled.load(Ordering::Relaxed);
faulthandler_disable_internal();
was_enabled
}
// faulthandler_is_enabled
#[pyfunction]
fn is_enabled() -> bool {
FATAL_ERROR.enabled.load(Ordering::Relaxed)
}
fn format_timeout(timeout_us: u64) -> String {
let sec = timeout_us / 1_000_000;
let us = timeout_us % 1_000_000;
let min = sec / 60;
let sec = sec % 60;
let hour = min / 60;
let min = min % 60;
// Match Python's timedelta str format: H:MM:SS.ffffff (no leading zero for hours)
if us != 0 {
format!("Timeout ({}:{:02}:{:02}.{:06})!\n", hour, min, sec, us)
} else {
format!("Timeout ({}:{:02}:{:02})!\n", hour, min, sec)
}
}
fn get_fd_from_file_opt(file: OptionalArg<PyObjectRef>, vm: &VirtualMachine) -> PyResult<i32> {
match file {
OptionalArg::Present(f) if !vm.is_none(&f) => {
// Check if it's an integer (file descriptor)
if let Ok(fd) = f.try_to_value::<i32>(vm) {
if fd < 0 {
return Err(vm.new_value_error("file is not a valid file descriptor"));
}
return Ok(fd);
}
// Try to get fileno() from file object
let fileno = vm.call_method(&f, "fileno", ())?;
let fd: i32 = fileno.try_to_value(vm)?;
if fd < 0 {
return Err(vm.new_value_error("file is not a valid file descriptor"));
}
// Try to flush the file
let _ = vm.call_method(&f, "flush", ());
Ok(fd)
}
_ => {
// file=None or file not passed: fall back to sys.stderr
let stderr = vm.sys_module.get_attr("stderr", vm)?;
if vm.is_none(&stderr) {
return Err(vm.new_runtime_error("sys.stderr is None"));
}
let fileno = vm.call_method(&stderr, "fileno", ())?;
let fd: i32 = fileno.try_to_value(vm)?;
let _ = vm.call_method(&stderr, "flush", ());
Ok(fd)
}
}
}
fn watchdog_thread(state: WatchdogHandle) {
let (lock, cvar) = &*state;
loop {
// Hold lock across wait_timeout to avoid race condition
let mut guard = lock.lock();
if guard.cancel {
return;
}
let timeout = Duration::from_micros(guard.timeout_us);
cvar.wait_for(&mut guard, timeout);
// Check if cancelled after wait
if guard.cancel {
return;
}
// Extract values before releasing lock for I/O
let repeat = guard.repeat;
let exit = guard.exit;
let fd = guard.fd;
let header = guard.header.clone();
#[cfg(feature = "threading")]
let thread_frame_slots = guard.thread_frame_slots.clone();
drop(guard); // Release lock before I/O
// Timeout occurred, dump traceback
#[cfg(target_arch = "wasm32")]
let _ = (exit, fd, &header);
#[cfg(not(target_arch = "wasm32"))]
{
puts_bytes(fd, header.as_bytes());
// Use thread frame slots when threading is enabled (includes all threads).
// Fall back to live frame walking for non-threaded builds.
#[cfg(feature = "threading")]
{
for (tid, slot) in &thread_frame_slots {
let frames = slot.frames.lock();
dump_traceback_thread_frames(fd, *tid, false, &frames);
}
}
#[cfg(not(feature = "threading"))]
{
write_thread_id(fd, current_thread_id(), false);
dump_live_frames(fd);
}
if exit {
std::process::exit(1);
}
}
if !repeat {
return;
}
}
}
#[derive(FromArgs)]
#[allow(unused)]
struct DumpTracebackLaterArgs {
#[pyarg(positional, error_msg = "timeout must be a number (int or float)")]
timeout: ArgIntoFloat,
#[pyarg(any, default = false)]
repeat: bool,
#[pyarg(any, default)]
file: OptionalArg<PyObjectRef>,
#[pyarg(any, default = false)]
exit: bool,
}
#[pyfunction]
fn dump_traceback_later(args: DumpTracebackLaterArgs, vm: &VirtualMachine) -> PyResult<()> {
let timeout: f64 = args.timeout.into_float();
if timeout <= 0.0 {
return Err(vm.new_value_error("timeout must be greater than 0"));
}
let fd = get_fd_from_file_opt(args.file, vm)?;
// Convert timeout to microseconds
let timeout_us = (timeout * 1_000_000.0) as u64;
if timeout_us == 0 {
return Err(vm.new_value_error("timeout must be greater than 0"));
}
let header = format_timeout(timeout_us);
// Snapshot thread frame slots so watchdog can dump tracebacks
#[cfg(feature = "threading")]
let thread_frame_slots: Vec<(u64, ThreadFrameSlot)> = {
let registry = vm.state.thread_frames.lock();
registry
.iter()
.map(|(&id, slot)| (id, Arc::clone(slot)))
.collect()
};
// Cancel any previous watchdog
cancel_dump_traceback_later();
// Create new watchdog state
let state = Arc::new((
Mutex::new(WatchdogState {
cancel: false,
fd,
timeout_us,
repeat: args.repeat,
exit: args.exit,
header,
#[cfg(feature = "threading")]
thread_frame_slots,
}),
Condvar::new(),
));
// Store the state
{
let mut watchdog = WATCHDOG.lock();
*watchdog = Some(Arc::clone(&state));
}
// Start watchdog thread
thread::spawn(move || {
watchdog_thread(state);
});
Ok(())
}
#[pyfunction]
fn cancel_dump_traceback_later() {
let state = {
let mut watchdog = WATCHDOG.lock();
watchdog.take()
};
if let Some(state) = state {
let (lock, cvar) = &*state;
{
let mut guard = lock.lock();
guard.cancel = true;
}
cvar.notify_all();
}
}
#[cfg(unix)]
mod user_signals {
use parking_lot::Mutex;
const NSIG: usize = 64;
#[derive(Clone, Copy)]
pub struct UserSignal {
pub enabled: bool,
pub fd: i32,
pub all_threads: bool,
pub chain: bool,
pub previous: libc::sigaction,
}
impl Default for UserSignal {
fn default() -> Self {
Self {