mirror of
https://github.com/rust-lang/rust.git
synced 2025-11-26 05:57:23 +00:00
This implements a new unstable compiler flag `-Zannotate-moves` that makes
move and copy operations visible in profilers by creating synthetic debug
information. This is achieved with zero runtime cost by manipulating debug
info scopes to make moves/copies appear as calls to `compiler_move<T, SIZE>`
and `compiler_copy<T, SIZE>` marker functions in profiling tools.
This allows developers to identify expensive move/copy operations in their
code using standard profiling tools, without requiring specialized tooling
or runtime instrumentation.
The implementation works at codegen time. When processing MIR operands
(`Operand::Move` and `Operand::Copy`), the codegen creates an `OperandRef`
with an optional `move_annotation` field containing an `Instance` of the
appropriate profiling marker function. When storing the operand,
`store_with_annotation()` wraps the store operation in a synthetic debug
scope that makes it appear inlined from the marker.
Two marker functions (`compiler_move` and `compiler_copy`) are defined
in `library/core/src/profiling.rs`. These are never actually called -
they exist solely as debug info anchors.
Operations are only annotated if the type:
- Meets the size threshold (default: 65 bytes, configurable via
`-Zannotate-moves=SIZE`)
- Has a non-scalar backend representation (scalars use registers,
not memcpy)
This has a very small size impact on object file size. With the default
limit it's well under 0.1%, and even with a very small limit of 8 bytes
it's still ~1.5%. This could be enabled by default.
36 lines
1.0 KiB
Rust
36 lines
1.0 KiB
Rust
//@ compile-flags: -Zannotate-moves=no -Copt-level=0 -g
|
|
// Test that move/copy operations are NOT annotated when the flag is disabled
|
|
|
|
#![crate_type = "lib"]
|
|
|
|
struct LargeStruct {
|
|
data: [u64; 20], // 160 bytes - would normally trigger annotation
|
|
}
|
|
|
|
impl Clone for LargeStruct {
|
|
// CHECK-LABEL: <disabled::LargeStruct as core::clone::Clone>::clone
|
|
fn clone(&self) -> Self {
|
|
// Should NOT be annotated when flag is disabled
|
|
// CHECK-NOT: compiler_copy
|
|
LargeStruct { data: self.data }
|
|
}
|
|
}
|
|
|
|
// CHECK-LABEL: disabled::test_large_copy_no_annotation
|
|
pub fn test_large_copy_no_annotation() {
|
|
let large = LargeStruct { data: [42; 20] };
|
|
// CHECK-NOT: compiler_copy
|
|
let _copy = large.clone();
|
|
}
|
|
|
|
// CHECK-LABEL: disabled::test_large_move_no_annotation
|
|
pub fn test_large_move_no_annotation() {
|
|
let large = LargeStruct { data: [42; 20] };
|
|
// CHECK-NOT: compiler_move
|
|
let _moved = large;
|
|
}
|
|
|
|
// Verify that no compiler_move or compiler_copy annotations exist anywhere
|
|
// CHECK-NOT: compiler_move
|
|
// CHECK-NOT: compiler_copy
|