Improve debug symbol names to avoid ambiguity and work better with MSVC's debugger
There are several cases where names of types and functions in the debug info are either ambiguous, or not helpful, such as including ambiguous placeholders (e.g., `{{impl}}`, `{{closure}}` or `dyn _'`) or dropping qualifications (e.g., for dynamic types).
Instead, each debug symbol name should be unique and useful:
* Include disambiguators for anonymous `DefPathDataName` (closures and generators), and unify their formatting when used as a path-qualifier vs item being qualified.
* Qualify the principal trait for dynamic types.
* If there is no principal trait for a dynamic type, emit all other traits instead.
* Respect the `qualified` argument when emitting ref and pointer types.
* For implementations, emit the disambiguator.
* Print const generics when emitting generic parameters or arguments.
Additionally, when targeting MSVC, its debugger treats many command arguments as C++ expressions, even when the argument is defined to be a symbol name. As such names in the debug info need to be more C++-like to be parsed correctly:
* Avoid characters with special meaning (`#`, `[`, `"`, `+`).
* Never start a name with `<` or `{` as this is treated as an operator.
* `>>` is always treated as a right-shift, even when parsing generic arguments (so add a space to avoid this).
* Emit function declarations using C/C++ style syntax (e.g., leading return type).
* Emit arrays as a synthetic `array$<type, size>` type.
* Include a `$` in all synthetic types as this is a legal character for C++, but not Rust (thus we avoid collisions with user types).
2021-06-24 10:36:28 -07:00
|
|
|
// Function names are formatted differently in old versions of GDB
|
|
|
|
|
// min-gdb-version: 9.2
|
|
|
|
|
|
|
|
|
|
// compile-flags:-g
|
|
|
|
|
|
|
|
|
|
// === GDB TESTS ===================================================================================
|
|
|
|
|
|
|
|
|
|
// Top-level function
|
|
|
|
|
// gdb-command:info functions -q function_names::main
|
|
|
|
|
// gdb-check:[...]static fn function_names::main();
|
|
|
|
|
// gdb-command:info functions -q function_names::generic_func<*
|
|
|
|
|
// gdb-check:[...]static fn function_names::generic_func(i32) -> i32;
|
|
|
|
|
|
|
|
|
|
// Implementations
|
|
|
|
|
// gdb-command:info functions -q function_names::.*::impl_function.*
|
|
|
|
|
// gdb-check:[...]static fn function_names::GenericStruct<T1,T2>::impl_function();
|
|
|
|
|
// gdb-check:[...]static fn function_names::Mod1::TestStruct2::impl_function();
|
|
|
|
|
// gdb-check:[...]static fn function_names::TestStruct1::impl_function();
|
|
|
|
|
|
|
|
|
|
// Trait implementations
|
|
|
|
|
// gdb-command:info functions -q function_names::.*::trait_function.*
|
|
|
|
|
// gdb-check:[...]static fn <function_names::GenericStruct<T,i32> as function_names::TestTrait1>::trait_function();
|
|
|
|
|
// gdb-check:[...]static fn <function_names::GenericStruct<[T; N],f32> as function_names::TestTrait1>::trait_function();
|
|
|
|
|
// gdb-check:[...]static fn <function_names::Mod1::TestStruct2 as function_names::Mod1::TestTrait2>::trait_function();
|
|
|
|
|
// gdb-check:[...]static fn <function_names::TestStruct1 as function_names::TestTrait1>::trait_function();
|
|
|
|
|
|
|
|
|
|
// Closure
|
|
|
|
|
// gdb-command:info functions -q function_names::.*::{{closure.*
|
|
|
|
|
// gdb-check:[...]static fn function_names::GenericStruct<T1,T2>::impl_function::{{closure}}(*mut function_names::{impl#2}::impl_function::{closure#0});
|
|
|
|
|
// gdb-check:[...]static fn function_names::generic_func::{{closure}}(*mut function_names::generic_func::{closure#0});
|
|
|
|
|
// gdb-check:[...]static fn function_names::main::{{closure}}(*mut function_names::main::{closure#0});
|
|
|
|
|
|
|
|
|
|
// Generator
|
|
|
|
|
// Generators don't seem to appear in GDB's symbol table.
|
|
|
|
|
|
2021-07-12 15:12:49 +02:00
|
|
|
// Const generic parameter
|
|
|
|
|
// gdb-command:info functions -q function_names::const_generic_fn.*
|
|
|
|
|
// gdb-check:[...]static fn function_names::const_generic_fn_bool();
|
|
|
|
|
// gdb-check:[...]static fn function_names::const_generic_fn_non_int();
|
|
|
|
|
// gdb-check:[...]static fn function_names::const_generic_fn_signed_int();
|
|
|
|
|
// gdb-check:[...]static fn function_names::const_generic_fn_unsigned_int();
|
|
|
|
|
|
Improve debug symbol names to avoid ambiguity and work better with MSVC's debugger
There are several cases where names of types and functions in the debug info are either ambiguous, or not helpful, such as including ambiguous placeholders (e.g., `{{impl}}`, `{{closure}}` or `dyn _'`) or dropping qualifications (e.g., for dynamic types).
Instead, each debug symbol name should be unique and useful:
* Include disambiguators for anonymous `DefPathDataName` (closures and generators), and unify their formatting when used as a path-qualifier vs item being qualified.
* Qualify the principal trait for dynamic types.
* If there is no principal trait for a dynamic type, emit all other traits instead.
* Respect the `qualified` argument when emitting ref and pointer types.
* For implementations, emit the disambiguator.
* Print const generics when emitting generic parameters or arguments.
Additionally, when targeting MSVC, its debugger treats many command arguments as C++ expressions, even when the argument is defined to be a symbol name. As such names in the debug info need to be more C++-like to be parsed correctly:
* Avoid characters with special meaning (`#`, `[`, `"`, `+`).
* Never start a name with `<` or `{` as this is treated as an operator.
* `>>` is always treated as a right-shift, even when parsing generic arguments (so add a space to avoid this).
* Emit function declarations using C/C++ style syntax (e.g., leading return type).
* Emit arrays as a synthetic `array$<type, size>` type.
* Include a `$` in all synthetic types as this is a legal character for C++, but not Rust (thus we avoid collisions with user types).
2021-06-24 10:36:28 -07:00
|
|
|
// === CDB TESTS ===================================================================================
|
|
|
|
|
|
|
|
|
|
// Top-level function
|
|
|
|
|
// cdb-command:x a!function_names::main
|
|
|
|
|
// cdb-check:[...] a!function_names::main (void)
|
|
|
|
|
// cdb-command:x a!function_names::generic_func<*
|
|
|
|
|
// cdb-check:[...] a!function_names::generic_func<i32> (int)
|
|
|
|
|
|
|
|
|
|
// Implementations
|
|
|
|
|
// cdb-command:x a!function_names::*::impl_function*
|
|
|
|
|
// cdb-check:[...] a!function_names::Mod1::TestStruct2::impl_function (void)
|
|
|
|
|
// cdb-check:[...] a!function_names::TestStruct1::impl_function (void)
|
|
|
|
|
// cdb-check:[...] a!function_names::GenericStruct<i32, i32>::impl_function<i32, i32> (void)
|
|
|
|
|
|
|
|
|
|
// Trait implementations
|
|
|
|
|
// cdb-command:x a!function_names::*::trait_function*
|
|
|
|
|
// cdb-check:[...] a!function_names::impl$3::trait_function<i32> (void)
|
|
|
|
|
// cdb-check:[...] a!function_names::impl$1::trait_function (void)
|
2021-07-12 15:12:49 +02:00
|
|
|
// cdb-check:[...] a!function_names::impl$6::trait_function<i32, 1> (void)
|
Improve debug symbol names to avoid ambiguity and work better with MSVC's debugger
There are several cases where names of types and functions in the debug info are either ambiguous, or not helpful, such as including ambiguous placeholders (e.g., `{{impl}}`, `{{closure}}` or `dyn _'`) or dropping qualifications (e.g., for dynamic types).
Instead, each debug symbol name should be unique and useful:
* Include disambiguators for anonymous `DefPathDataName` (closures and generators), and unify their formatting when used as a path-qualifier vs item being qualified.
* Qualify the principal trait for dynamic types.
* If there is no principal trait for a dynamic type, emit all other traits instead.
* Respect the `qualified` argument when emitting ref and pointer types.
* For implementations, emit the disambiguator.
* Print const generics when emitting generic parameters or arguments.
Additionally, when targeting MSVC, its debugger treats many command arguments as C++ expressions, even when the argument is defined to be a symbol name. As such names in the debug info need to be more C++-like to be parsed correctly:
* Avoid characters with special meaning (`#`, `[`, `"`, `+`).
* Never start a name with `<` or `{` as this is treated as an operator.
* `>>` is always treated as a right-shift, even when parsing generic arguments (so add a space to avoid this).
* Emit function declarations using C/C++ style syntax (e.g., leading return type).
* Emit arrays as a synthetic `array$<type, size>` type.
* Include a `$` in all synthetic types as this is a legal character for C++, but not Rust (thus we avoid collisions with user types).
2021-06-24 10:36:28 -07:00
|
|
|
// cdb-check:[...] a!function_names::impl$5::trait_function3<function_names::TestStruct1> (void)
|
|
|
|
|
// cdb-check:[...] a!function_names::Mod1::impl$1::trait_function (void)
|
|
|
|
|
|
|
|
|
|
// Closure
|
|
|
|
|
// cdb-command:x a!function_names::*::closure*
|
|
|
|
|
// cdb-check:[...] a!function_names::main::closure$0 (void)
|
|
|
|
|
// cdb-check:[...] a!function_names::generic_func::closure$0<i32> (void)
|
|
|
|
|
// cdb-check:[...] a!function_names::impl$2::impl_function::closure$0<i32, i32> (void)
|
|
|
|
|
|
|
|
|
|
// Generator
|
|
|
|
|
// cdb-command:x a!function_names::*::generator*
|
|
|
|
|
// cdb-check:[...] a!function_names::main::generator$1 (void)
|
|
|
|
|
|
2021-07-12 15:12:49 +02:00
|
|
|
// Const generic parameter
|
|
|
|
|
// cdb-command:x a!function_names::const_generic_fn*
|
|
|
|
|
// cdb-check:[...] a!function_names::const_generic_fn_bool<false> (void)
|
|
|
|
|
// cdb-check:[...] a!function_names::const_generic_fn_non_int<CONST$fe3cfa0214ac55c7> (void)
|
|
|
|
|
// cdb-check:[...] a!function_names::const_generic_fn_unsigned_int<14> (void)
|
|
|
|
|
// cdb-check:[...] a!function_names::const_generic_fn_signed_int<-7> (void)
|
|
|
|
|
|
Improve debug symbol names to avoid ambiguity and work better with MSVC's debugger
There are several cases where names of types and functions in the debug info are either ambiguous, or not helpful, such as including ambiguous placeholders (e.g., `{{impl}}`, `{{closure}}` or `dyn _'`) or dropping qualifications (e.g., for dynamic types).
Instead, each debug symbol name should be unique and useful:
* Include disambiguators for anonymous `DefPathDataName` (closures and generators), and unify their formatting when used as a path-qualifier vs item being qualified.
* Qualify the principal trait for dynamic types.
* If there is no principal trait for a dynamic type, emit all other traits instead.
* Respect the `qualified` argument when emitting ref and pointer types.
* For implementations, emit the disambiguator.
* Print const generics when emitting generic parameters or arguments.
Additionally, when targeting MSVC, its debugger treats many command arguments as C++ expressions, even when the argument is defined to be a symbol name. As such names in the debug info need to be more C++-like to be parsed correctly:
* Avoid characters with special meaning (`#`, `[`, `"`, `+`).
* Never start a name with `<` or `{` as this is treated as an operator.
* `>>` is always treated as a right-shift, even when parsing generic arguments (so add a space to avoid this).
* Emit function declarations using C/C++ style syntax (e.g., leading return type).
* Emit arrays as a synthetic `array$<type, size>` type.
* Include a `$` in all synthetic types as this is a legal character for C++, but not Rust (thus we avoid collisions with user types).
2021-06-24 10:36:28 -07:00
|
|
|
#![allow(unused_variables)]
|
|
|
|
|
#![feature(omit_gdb_pretty_printer_section)]
|
|
|
|
|
#![omit_gdb_pretty_printer_section]
|
2021-07-12 15:12:49 +02:00
|
|
|
#![feature(const_generics, generators, generator_trait)]
|
|
|
|
|
#![allow(incomplete_features)] // for const_generics
|
Improve debug symbol names to avoid ambiguity and work better with MSVC's debugger
There are several cases where names of types and functions in the debug info are either ambiguous, or not helpful, such as including ambiguous placeholders (e.g., `{{impl}}`, `{{closure}}` or `dyn _'`) or dropping qualifications (e.g., for dynamic types).
Instead, each debug symbol name should be unique and useful:
* Include disambiguators for anonymous `DefPathDataName` (closures and generators), and unify their formatting when used as a path-qualifier vs item being qualified.
* Qualify the principal trait for dynamic types.
* If there is no principal trait for a dynamic type, emit all other traits instead.
* Respect the `qualified` argument when emitting ref and pointer types.
* For implementations, emit the disambiguator.
* Print const generics when emitting generic parameters or arguments.
Additionally, when targeting MSVC, its debugger treats many command arguments as C++ expressions, even when the argument is defined to be a symbol name. As such names in the debug info need to be more C++-like to be parsed correctly:
* Avoid characters with special meaning (`#`, `[`, `"`, `+`).
* Never start a name with `<` or `{` as this is treated as an operator.
* `>>` is always treated as a right-shift, even when parsing generic arguments (so add a space to avoid this).
* Emit function declarations using C/C++ style syntax (e.g., leading return type).
* Emit arrays as a synthetic `array$<type, size>` type.
* Include a `$` in all synthetic types as this is a legal character for C++, but not Rust (thus we avoid collisions with user types).
2021-06-24 10:36:28 -07:00
|
|
|
|
|
|
|
|
use Mod1::TestTrait2;
|
|
|
|
|
use std::ops::Generator;
|
|
|
|
|
use std::pin::Pin;
|
|
|
|
|
|
|
|
|
|
fn main() {
|
|
|
|
|
// Implementations
|
|
|
|
|
TestStruct1::impl_function();
|
|
|
|
|
Mod1::TestStruct2::impl_function();
|
|
|
|
|
GenericStruct::<i32, i32>::impl_function();
|
|
|
|
|
|
|
|
|
|
// Trait implementations
|
|
|
|
|
TestStruct1::trait_function();
|
|
|
|
|
Mod1::TestStruct2::trait_function();
|
|
|
|
|
GenericStruct::<i32, i32>::trait_function();
|
|
|
|
|
GenericStruct::<[i32; 1], f32>::trait_function();
|
|
|
|
|
GenericStruct::<TestStruct1, usize>::trait_function3();
|
|
|
|
|
|
|
|
|
|
// Generic function
|
|
|
|
|
let _ = generic_func(42);
|
|
|
|
|
|
|
|
|
|
// Closure
|
|
|
|
|
let closure = || { TestStruct1 };
|
|
|
|
|
closure();
|
|
|
|
|
|
|
|
|
|
// Generator
|
|
|
|
|
let mut generator = || { yield; return; };
|
|
|
|
|
Pin::new(&mut generator).resume(());
|
2021-07-12 15:12:49 +02:00
|
|
|
|
|
|
|
|
// Const generic functions
|
|
|
|
|
const_generic_fn_bool::<false>();
|
|
|
|
|
const_generic_fn_non_int::<{()}>();
|
|
|
|
|
const_generic_fn_signed_int::<-7>();
|
|
|
|
|
const_generic_fn_unsigned_int::<14>();
|
Improve debug symbol names to avoid ambiguity and work better with MSVC's debugger
There are several cases where names of types and functions in the debug info are either ambiguous, or not helpful, such as including ambiguous placeholders (e.g., `{{impl}}`, `{{closure}}` or `dyn _'`) or dropping qualifications (e.g., for dynamic types).
Instead, each debug symbol name should be unique and useful:
* Include disambiguators for anonymous `DefPathDataName` (closures and generators), and unify their formatting when used as a path-qualifier vs item being qualified.
* Qualify the principal trait for dynamic types.
* If there is no principal trait for a dynamic type, emit all other traits instead.
* Respect the `qualified` argument when emitting ref and pointer types.
* For implementations, emit the disambiguator.
* Print const generics when emitting generic parameters or arguments.
Additionally, when targeting MSVC, its debugger treats many command arguments as C++ expressions, even when the argument is defined to be a symbol name. As such names in the debug info need to be more C++-like to be parsed correctly:
* Avoid characters with special meaning (`#`, `[`, `"`, `+`).
* Never start a name with `<` or `{` as this is treated as an operator.
* `>>` is always treated as a right-shift, even when parsing generic arguments (so add a space to avoid this).
* Emit function declarations using C/C++ style syntax (e.g., leading return type).
* Emit arrays as a synthetic `array$<type, size>` type.
* Include a `$` in all synthetic types as this is a legal character for C++, but not Rust (thus we avoid collisions with user types).
2021-06-24 10:36:28 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
struct TestStruct1;
|
|
|
|
|
trait TestTrait1 {
|
|
|
|
|
fn trait_function();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Implementation
|
|
|
|
|
impl TestStruct1 {
|
|
|
|
|
pub fn impl_function() {}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Implementation for a trait
|
|
|
|
|
impl TestTrait1 for TestStruct1 {
|
|
|
|
|
fn trait_function() {}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Implementation and implementation within a mod
|
|
|
|
|
mod Mod1 {
|
|
|
|
|
pub struct TestStruct2;
|
|
|
|
|
pub trait TestTrait2 {
|
|
|
|
|
fn trait_function();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl TestStruct2 {
|
|
|
|
|
pub fn impl_function() {}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl TestTrait2 for TestStruct2 {
|
|
|
|
|
fn trait_function() {}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
struct GenericStruct<T1, T2>(std::marker::PhantomData<(T1, T2)>);
|
|
|
|
|
|
|
|
|
|
// Generic implementation
|
|
|
|
|
impl<T1, T2> GenericStruct<T1, T2> {
|
|
|
|
|
pub fn impl_function() {
|
|
|
|
|
// Closure in a generic implementation
|
|
|
|
|
let closure = || { TestStruct1 };
|
|
|
|
|
closure();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Generic trait implementation
|
|
|
|
|
impl<T> TestTrait1 for GenericStruct<T, i32> {
|
|
|
|
|
fn trait_function() {}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Implementation based on associated type
|
|
|
|
|
trait TestTrait3 {
|
|
|
|
|
type AssocType;
|
|
|
|
|
fn trait_function3();
|
|
|
|
|
}
|
|
|
|
|
impl TestTrait3 for TestStruct1 {
|
|
|
|
|
type AssocType = usize;
|
|
|
|
|
fn trait_function3() {}
|
|
|
|
|
}
|
|
|
|
|
impl<T: TestTrait3> TestTrait3 for GenericStruct<T, T::AssocType> {
|
|
|
|
|
type AssocType = T::AssocType;
|
|
|
|
|
fn trait_function3() {}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Generic trait implementation with const generics
|
|
|
|
|
impl<T, const N: usize> TestTrait1 for GenericStruct<[T; N], f32> {
|
|
|
|
|
fn trait_function() {}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Generic function
|
|
|
|
|
fn generic_func<T>(value: T) -> T {
|
|
|
|
|
// Closure in a generic function
|
|
|
|
|
let closure = || { TestStruct1 };
|
|
|
|
|
closure();
|
|
|
|
|
|
|
|
|
|
value
|
|
|
|
|
}
|
2021-07-12 15:12:49 +02:00
|
|
|
|
|
|
|
|
fn const_generic_fn_bool<const C: bool>() {}
|
|
|
|
|
fn const_generic_fn_non_int<const C: ()>() {}
|
|
|
|
|
fn const_generic_fn_signed_int<const C: i64>() {}
|
|
|
|
|
fn const_generic_fn_unsigned_int<const C: u32>() {}
|