tests/codegen/debuginfo-generic-closure-env-names.rs

   1 // This test checks that we get proper type names for closure environments and
   2 // async-fn environments in debuginfo, especially making sure that generic arguments
   3 // of the enclosing functions don't get lost.
   4 //
   5 // Unfortunately, the order that debuginfo gets emitted into LLVM IR becomes a bit hard
   6 // to predict once async fns are involved, so DAG allows any order.
   7 //
   8 // Note that the test does not check async-fns when targeting MSVC because debuginfo for
   9 // those does not follow the enum-fallback encoding yet and thus is incomplete.
  10
  11 // ignore-tidy-linelength
  12
  13 // Use the v0 symbol mangling scheme to codegen order independent of rustc version.
  14 // Unnamed items like shims are generated in lexicographical order of their symbol name and in the
  15 // legacy mangling scheme rustc version and generic parameters are both hashed into a single part
  16 // of the name, thus randomizing item order with respect to rustc version.
  17
  18 // compile-flags: -Cdebuginfo=2 --edition 2021 -Copt-level=0 -Csymbol-mangling-version=v0
  19
  20 // non_generic_closure()
  21 // NONMSVC: !DICompositeType(tag: DW_TAG_structure_type, name: "{closure_env#0}", scope: ![[non_generic_closure_NAMESPACE:[0-9]+]],
  22 // MSVC: !DICompositeType(tag: DW_TAG_structure_type, name: "closure_env$0", scope: ![[non_generic_closure_NAMESPACE:[0-9]+]],
  23 // CHECK: ![[non_generic_closure_NAMESPACE]] = !DINamespace(name: "non_generic_closure"
  24
  25 // CHECK: ![[function_containing_closure_NAMESPACE:[0-9]+]] = !DINamespace(name: "function_containing_closure"
  26 // CHECK: ![[generic_async_function_NAMESPACE:[0-9]+]] = !DINamespace(name: "generic_async_function"
  27 // CHECK: ![[generic_async_block_NAMESPACE:[0-9]+]] = !DINamespace(name: "generic_async_block"
  28
  29 // function_containing_closure<u32>()
  30 // NONMSVC-DAG: !DICompositeType(tag: DW_TAG_structure_type, name: "{closure_env#0}<u32>", scope: ![[function_containing_closure_NAMESPACE]]
  31 // MSVC-DAG: !DICompositeType(tag: DW_TAG_structure_type, name: "closure_env$0<u32>", scope: ![[function_containing_closure_NAMESPACE]]
  32
  33 // generic_async_function<Foo>()
  34 // NONMSVC-DAG: !DICompositeType(tag: DW_TAG_structure_type, name: "{async_fn_env#0}<debuginfo_generic_closure_env_names::Foo>", scope: ![[generic_async_function_NAMESPACE]]
  35
  36 // generic_async_function<u32>()
  37 // NONMSVC-DAG: !DICompositeType(tag: DW_TAG_structure_type, name: "{async_fn_env#0}<u32>", scope: ![[generic_async_function_NAMESPACE]]
  38
  39 // generic_async_block<Foo>()
  40 // NONMSVC-DAG: !DICompositeType(tag: DW_TAG_structure_type, name: "{async_block_env#0}<debuginfo_generic_closure_env_names::Foo>", scope: ![[generic_async_block_NAMESPACE]]
  41
  42 // generic_async_block<u32>()
  43 // NONMSVC-DAG: !DICompositeType(tag: DW_TAG_structure_type, name: "{async_block_env#0}<u32>", scope: ![[generic_async_block_NAMESPACE]]
  44
  45 // function_containing_closure<Foo>()
  46 // NONMSVC-DAG: !DICompositeType(tag: DW_TAG_structure_type, name: "{closure_env#0}<debuginfo_generic_closure_env_names::Foo>", scope: ![[function_containing_closure_NAMESPACE]]
  47 // MSVC-DAG: !DICompositeType(tag: DW_TAG_structure_type, name: "closure_env$0<debuginfo_generic_closure_env_names::Foo>", scope: ![[function_containing_closure_NAMESPACE]]
  48
  49
  50 #![crate_type = "lib"]
  51 use std::future::Future;
  52
  53 pub struct Foo;
  54
  55 pub fn non_generic_closure(x: Foo) -> Box<dyn FnOnce() -> Foo> {
  56     return Box::new(move || x);
  57 }
  58
  59 fn function_containing_closure<T: 'static>(x: T) -> impl FnOnce() -> T {
  60     // This static only exists to trigger generating the namespace debuginfo for
  61     // `function_containing_closure` at a predictable, early point, which makes
  62     // writing the FileCheck tests above simpler.
  63     static _X: u8 = 0;
  64
  65     return move || x;
  66 }
  67
  68 async fn generic_async_function<T: 'static>(x: T) -> T {
  69     static _X: u8 = 0; // Same as above
  70     x
  71 }
  72
  73 fn generic_async_block<T: 'static>(x: T) -> impl Future<Output=T> {
  74     static _X: u8 = 0; // Same as above
  75     async move {
  76         x
  77     }
  78 }
  79
  80 pub fn instantiate_generics() {
  81     let _closure_u32 = function_containing_closure(7u32);
  82     let _closure_foo = function_containing_closure(Foo);
  83
  84     let _async_fn_u32 = generic_async_function(42u32);
  85     let _async_fn_foo = generic_async_function(Foo);
  86
  87     let _async_block_u32 = generic_async_block(64u32);
  88     let _async_block_foo = generic_async_block(Foo);
  89 }