diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2024-12-03 21:55:27 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-12-03 21:55:27 +0100 |
| commit | e66e6324798768b045c77c099caa8073d5dce983 (patch) | |
| tree | 3fcffdc422d9cd69e79d20a63444246a25eab965 /library/core | |
| parent | 6e87eb58ede97cce4bd1e392694f88a2a2936e84 (diff) | |
| parent | cea0582dbdd231c46884ca917de3e32b75b6287a (diff) | |
| download | rust-e66e6324798768b045c77c099caa8073d5dce983.tar.gz rust-e66e6324798768b045c77c099caa8073d5dce983.zip | |
Rollup merge of #133726 - joshtriplett:breakpoint, r=oli-obk
Add `core::arch::breakpoint` and test Approved in [ACP 491](https://github.com/rust-lang/libs-team/issues/491).
Diffstat (limited to 'library/core')
| -rw-r--r-- | library/core/src/arch.rs | 27 | ||||
| -rw-r--r-- | library/core/src/intrinsics/mod.rs | 12 |
2 files changed, 39 insertions, 0 deletions
diff --git a/library/core/src/arch.rs b/library/core/src/arch.rs index 57f456c98b3..95d88c7f679 100644 --- a/library/core/src/arch.rs +++ b/library/core/src/arch.rs @@ -42,3 +42,30 @@ pub macro naked_asm("assembly template", $(operands,)* $(options($(option),*))?) pub macro global_asm("assembly template", $(operands,)* $(options($(option),*))?) { /* compiler built-in */ } + +/// Compiles to a target-specific software breakpoint instruction or equivalent. +/// +/// This will typically abort the program. It may result in a core dump, and/or the system logging +/// debug information. Additional target-specific capabilities may be possible depending on +/// debuggers or other tooling; in particular, a debugger may be able to resume execution. +/// +/// If possible, this will produce an instruction sequence that allows a debugger to resume *after* +/// the breakpoint, rather than resuming *at* the breakpoint; however, the exact behavior is +/// target-specific and debugger-specific, and not guaranteed. +/// +/// If the target platform does not have any kind of debug breakpoint instruction, this may compile +/// to a trapping instruction (e.g. an undefined instruction) instead, or to some other form of +/// target-specific abort that may or may not support convenient resumption. +/// +/// The precise behavior and the precise instruction generated are not guaranteed, except that in +/// normal execution with no debug tooling involved this will not continue executing. +/// +/// - On x86 targets, this produces an `int3` instruction. +/// - On aarch64 targets, this produces a `brk #0xf000` instruction. +// When stabilizing this, update the comment on `core::intrinsics::breakpoint`. +#[unstable(feature = "breakpoint", issue = "133724")] +#[inline(always)] +#[cfg(not(bootstrap))] +pub fn breakpoint() { + core::intrinsics::breakpoint(); +} diff --git a/library/core/src/intrinsics/mod.rs b/library/core/src/intrinsics/mod.rs index 46873fdc047..4c8fd922f19 100644 --- a/library/core/src/intrinsics/mod.rs +++ b/library/core/src/intrinsics/mod.rs @@ -1381,6 +1381,18 @@ pub unsafe fn prefetch_write_instruction<T>(_data: *const T, _locality: i32) { #[rustc_intrinsic] #[rustc_intrinsic_must_be_overridden] #[rustc_nounwind] +#[cfg(not(bootstrap))] +pub fn breakpoint() { + unreachable!() +} + +/// Executes a breakpoint trap, for inspection by a debugger. +/// +/// This intrinsic does not have a stable counterpart. +#[rustc_intrinsic] +#[rustc_intrinsic_must_be_overridden] +#[rustc_nounwind] +#[cfg(bootstrap)] pub unsafe fn breakpoint() { unreachable!() } |
