]> git.lizzy.rs Git - rust.git/blob - src/test/debuginfo/type-names.rs
debuginfo: Refactor debuginfo generation for types
[rust.git] / src / test / debuginfo / type-names.rs
1 // ignore-lldb
2
3 // GDB changed the way that it formatted Foreign types
4 // min-gdb-version: 9.2
5
6 // compile-flags:-g
7
8 // === GDB TESTS ===================================================================================
9
10 // gdb-command:run
11
12 // STRUCTS
13 // gdb-command:whatis simple_struct
14 // gdb-check:type = type_names::Struct1
15
16 // gdb-command:whatis generic_struct1
17 // gdb-check:type = type_names::GenericStruct<type_names::mod1::Struct2, type_names::mod1::mod2::Struct3>
18
19 // gdb-command:whatis generic_struct2
20 // gdb-check:type = type_names::GenericStruct<type_names::Struct1, extern "fastcall" fn(isize) -> usize>
21
22 // gdb-command:whatis mod_struct
23 // gdb-check:type = type_names::mod1::Struct2
24
25 // ENUMS
26 // gdb-command:whatis simple_enum_1
27 // gdb-check:type = type_names::Enum1
28
29 // gdb-command:whatis simple_enum_2
30 // gdb-check:type = type_names::Enum1
31
32 // gdb-command:whatis simple_enum_3
33 // gdb-check:type = type_names::mod1::Enum2
34
35 // gdb-command:whatis generic_enum_1
36 // gdb-check:type = type_names::mod1::mod2::Enum3<type_names::mod1::Struct2>
37
38 // gdb-command:whatis generic_enum_2
39 // gdb-check:type = type_names::mod1::mod2::Enum3<type_names::Struct1>
40
41 // TUPLES
42 // gdb-command:whatis tuple1
43 // gdb-check:type = (u32, type_names::Struct1, type_names::mod1::mod2::Enum3<type_names::mod1::Struct2>)
44
45 // gdb-command:whatis tuple2
46 // gdb-check:type = ((type_names::Struct1, type_names::mod1::mod2::Struct3), type_names::mod1::Enum2, char)
47
48 // BOX
49 // gdb-command:whatis box1
50 // gdb-check:type = (alloc::boxed::Box<f32, alloc::alloc::Global>, i32)
51
52 // gdb-command:whatis box2
53 // gdb-check:type = (alloc::boxed::Box<type_names::mod1::mod2::Enum3<f32>, alloc::alloc::Global>, i32)
54
55 // REFERENCES
56 // gdb-command:whatis ref1
57 // gdb-check:type = (&type_names::Struct1, i32)
58
59 // gdb-command:whatis ref2
60 // gdb-check:type = (&type_names::GenericStruct<char, type_names::Struct1>, i32)
61
62 // gdb-command:whatis mut_ref1
63 // gdb-check:type = (&mut type_names::Struct1, i32)
64
65 // gdb-command:whatis mut_ref2
66 // gdb-check:type = (&mut type_names::GenericStruct<type_names::mod1::Enum2, f64>, i32)
67
68 // RAW POINTERS
69 // gdb-command:whatis mut_ptr1
70 // gdb-check:type = (*mut type_names::Struct1, isize)
71
72 // gdb-command:whatis mut_ptr2
73 // gdb-check:type = (*mut isize, isize)
74
75 // gdb-command:whatis mut_ptr3
76 // gdb-check:type = (*mut type_names::mod1::mod2::Enum3<type_names::Struct1>, isize)
77
78 // gdb-command:whatis const_ptr1
79 // gdb-check:type = (*const type_names::Struct1, isize)
80
81 // gdb-command:whatis const_ptr2
82 // gdb-check:type = (*const isize, isize)
83
84 // gdb-command:whatis const_ptr3
85 // gdb-check:type = (*const type_names::mod1::mod2::Enum3<type_names::Struct1>, isize)
86
87 // VECTORS
88 // gdb-command:whatis fixed_size_vec1
89 // gdb-check:type = ([type_names::Struct1; 3], i16)
90
91 // gdb-command:whatis fixed_size_vec2
92 // gdb-check:type = ([usize; 3], i16)
93
94 // gdb-command:whatis slice1
95 // gdb-check:type = &[usize]
96
97 // gdb-command:whatis slice2
98 // gdb-check:type = &[type_names::mod1::Enum2]
99
100 // TRAITS
101 // gdb-command:whatis box_trait
102 // gdb-check:type = alloc::boxed::Box<dyn type_names::Trait1, alloc::alloc::Global>
103
104 // gdb-command:whatis ref_trait
105 // gdb-check:type = &dyn type_names::Trait1
106
107 // gdb-command:whatis mut_ref_trait
108 // gdb-check:type = &mut dyn type_names::Trait1
109
110 // gdb-command:whatis generic_box_trait
111 // gdb-check:type = alloc::boxed::Box<dyn type_names::Trait2<i32, type_names::mod1::Struct2>, alloc::alloc::Global>
112
113 // gdb-command:whatis generic_ref_trait
114 // gdb-check:type = &dyn type_names::Trait2<type_names::Struct1, type_names::Struct1>
115
116 // gdb-command:whatis generic_mut_ref_trait
117 // gdb-check:type = &mut dyn type_names::Trait2<type_names::mod1::mod2::Struct3, type_names::GenericStruct<usize, isize>>
118
119 // gdb-command:whatis no_principal_trait
120 // gdb-check:type = alloc::boxed::Box<(dyn core::marker::Send + core::marker::Sync), alloc::alloc::Global>
121
122 // gdb-command:whatis has_associated_type_trait
123 // gdb-check:type = &(dyn type_names::Trait3<u32, AssocType=isize> + core::marker::Send)
124
125 // BARE FUNCTIONS
126 // gdb-command:whatis rust_fn
127 // gdb-check:type = (fn(core::option::Option<isize>, core::option::Option<&type_names::mod1::Struct2>), usize)
128
129 // gdb-command:whatis extern_c_fn
130 // gdb-check:type = (extern "C" fn(isize), usize)
131
132 // gdb-command:whatis unsafe_fn
133 // gdb-check:type = (unsafe fn(core::result::Result<char, f64>), usize)
134
135 // gdb-command:whatis rust_fn_with_return_value
136 // gdb-check:type = (fn(f64) -> usize, usize)
137
138 // gdb-command:whatis extern_c_fn_with_return_value
139 // gdb-check:type = (extern "C" fn() -> type_names::Struct1, usize)
140
141 // gdb-command:whatis unsafe_fn_with_return_value
142 // gdb-check:type = (unsafe fn(type_names::GenericStruct<u16, u8>) -> type_names::mod1::Struct2, usize)
143
144 // gdb-command:whatis generic_function_int
145 // gdb-check:type = (fn(isize) -> isize, usize)
146
147 // gdb-command:whatis generic_function_struct3
148 // gdb-check:type = (fn(type_names::mod1::mod2::Struct3) -> type_names::mod1::mod2::Struct3, usize)
149
150 // gdb-command:whatis variadic_function
151 // gdb-check:type = (unsafe extern "C" fn(*const u8, ...) -> isize, usize)
152
153 // CLOSURES
154 // gdb-command:whatis closure1
155 // gdb-check:type = (type_names::main::{closure_env#0}, usize)
156
157 // gdb-command:whatis closure2
158 // gdb-check:type = (type_names::main::{closure_env#1}, usize)
159
160 // FOREIGN TYPES
161 // gdb-command:whatis foreign1
162 // gdb-check:type = *mut type_names::{extern#0}::ForeignType1
163
164 // gdb-command:whatis foreign2
165 // gdb-check:type = *mut type_names::mod1::{extern#0}::ForeignType2
166
167 // === CDB TESTS ==================================================================================
168
169 // cdb-command: g
170
171 // STRUCTS
172 // 0-sized structs appear to be optimized away in some cases, so only check the structs that do
173 // actually appear.
174 // cdb-command:dv /t *_struct
175 // cdb-check:struct type_names::GenericStruct<enum$<type_names::mod1::Enum2>,f64> mut_generic_struct = [...]
176
177 // ENUMS
178 // cdb-command:dv /t *_enum_*
179 // cdb-check:union enum$<type_names::Enum1> simple_enum_1 = [...]
180 // cdb-check:union enum$<type_names::Enum1> simple_enum_2 = [...]
181 // cdb-check:union enum$<type_names::mod1::Enum2> simple_enum_3 = [...]
182 // cdb-check:union enum$<type_names::mod1::mod2::Enum3<type_names::mod1::Struct2> > generic_enum_1 = [...]
183 // cdb-check:union enum$<type_names::mod1::mod2::Enum3<type_names::Struct1> > generic_enum_2 = [...]
184
185 // TUPLES
186 // cdb-command:dv /t tuple*
187 // cdb-check:struct tuple$<u32,type_names::Struct1,enum$<type_names::mod1::mod2::Enum3<type_names::mod1::Struct2> > > tuple1 = [...]
188 // cdb-check:struct tuple$<tuple$<type_names::Struct1,type_names::mod1::mod2::Struct3>,enum$<type_names::mod1::Enum2>,char> tuple2 = [...]
189
190 // BOX
191 // cdb-command:dv /t box*
192 // cdb-check:struct tuple$<alloc::boxed::Box<f32,alloc::alloc::Global>,i32> box1 = [...]
193 // cdb-check:struct tuple$<alloc::boxed::Box<enum$<type_names::mod1::mod2::Enum3<f32> >,alloc::alloc::Global>,i32> box2 = [...]
194
195 // REFERENCES
196 // cdb-command:dv /t *ref*
197 // cdb-check:struct tuple$<ref$<type_names::Struct1>,i32> ref1 = [...]
198 // cdb-check:struct tuple$<ref$<type_names::GenericStruct<char,type_names::Struct1> >,i32> ref2 = [...]
199 // cdb-check:struct tuple$<ref_mut$<type_names::Struct1>,i32> mut_ref1 = [...]
200 // cdb-check:struct tuple$<ref_mut$<type_names::GenericStruct<enum$<type_names::mod1::Enum2>,f64> >,i32> mut_ref2 = [...]
201
202 // RAW POINTERS
203 // cdb-command:dv /t *_ptr*
204 // cdb-check:struct tuple$<ptr_mut$<type_names::Struct1>,isize> mut_ptr1 = [...]
205 // cdb-check:struct tuple$<ptr_mut$<isize>,isize> mut_ptr2 = [...]
206 // cdb-check:struct tuple$<ptr_mut$<enum$<type_names::mod1::mod2::Enum3<type_names::Struct1> > >,isize> mut_ptr3 = [...]
207 // cdb-check:struct tuple$<ptr_const$<type_names::Struct1>,isize> const_ptr1 = [...]
208 // cdb-check:struct tuple$<ptr_const$<isize>,isize> const_ptr2 = [...]
209 // cdb-check:struct tuple$<ptr_const$<enum$<type_names::mod1::mod2::Enum3<type_names::Struct1> > >,isize> const_ptr3 = [...]
210
211 // VECTORS
212 // cdb-command:dv /t *vec*
213 // cdb-check:struct tuple$<array$<type_names::Struct1,3>,i16> fixed_size_vec1 = [...]
214 // cdb-check:struct tuple$<array$<usize,3>,i16> fixed_size_vec2 = [...]
215 // cdb-check:struct alloc::vec::Vec<usize,alloc::alloc::Global> vec1 = [...]
216 // cdb-check:struct alloc::vec::Vec<enum$<type_names::mod1::Enum2>,alloc::alloc::Global> vec2 = [...]
217 // cdb-command:dv /t slice*
218 // cdb-check:struct slice$<usize> slice1 = [...]
219 // cdb-check:struct slice$<enum$<type_names::mod1::Enum2> > slice2 = [...]
220
221 // TRAITS
222 // cdb-command:dv /t *_trait
223 // cdb-check:struct ref_mut$<dyn$<type_names::Trait2<type_names::mod1::mod2::Struct3,type_names::GenericStruct<usize,isize> > > > generic_mut_ref_trait = [...]
224 // cdb-check:struct ref$<dyn$<type_names::Trait2<type_names::Struct1,type_names::Struct1> > > generic_ref_trait = [...]
225 // cdb-check:struct alloc::boxed::Box<dyn$<type_names::Trait2<i32,type_names::mod1::Struct2> >,alloc::alloc::Global> generic_box_trait = [...]
226 // cdb-check:struct alloc::boxed::Box<dyn$<type_names::Trait1>,alloc::alloc::Global> box_trait = [...]
227 // cdb-check:struct ref$<dyn$<type_names::Trait1> > ref_trait = [...]
228 // cdb-check:struct ref_mut$<dyn$<type_names::Trait1> > mut_ref_trait = [...]
229 // cdb-check:struct alloc::boxed::Box<dyn$<core::marker::Send,core::marker::Sync>,alloc::alloc::Global> no_principal_trait = [...]
230 // cdb-check:struct ref$<dyn$<type_names::Trait3<u32,assoc$<AssocType,isize> >,core::marker::Send> > has_associated_type_trait = struct ref$<dyn$<type_names::Trait3<u32,assoc$<AssocType,isize> >,core::marker::Send> >
231
232 // BARE FUNCTIONS
233 // cdb-command:dv /t *_fn*
234 // cdb-check:struct tuple$<type_names::mod1::Struct2 (*)(type_names::GenericStruct<u16,u8>),usize> unsafe_fn_with_return_value = [...]
235 // cdb-check:struct tuple$<type_names::Struct1 (*)(),usize> extern_c_fn_with_return_value = [...]
236 // cdb-check:struct tuple$<usize (*)(f64),usize> rust_fn_with_return_value = [...]
237 // cdb-check:struct tuple$<void (*)(enum$<core::result::Result<char,f64> >),usize> unsafe_fn = [...]
238 // cdb-check:struct tuple$<void (*)(isize),usize> extern_c_fn = [...]
239 // cdb-check:struct tuple$<void (*)(enum$<core::option::Option<isize> >,enum$<core::option::Option<ref$<type_names::mod1::Struct2> >, 1, [...], Some>),usize> rust_fn = [...]
240 // cdb-command:dv /t *_function*
241 // cdb-check:struct tuple$<isize (*)(ptr_const$<u8>, ...),usize> variadic_function = [...]
242 // cdb-check:struct tuple$<type_names::mod1::mod2::Struct3 (*)(type_names::mod1::mod2::Struct3),usize> generic_function_struct3 = [...]
243 // cdb-check:struct tuple$<isize (*)(isize),usize> generic_function_int = [...]
244 // cdb-command:dx Debugger.State.Scripts.@"type-names.cdb".Contents.getFunctionDetails("rust_fn")
245 // cdb-check:Return Type: void
246 // cdb-check:Parameter Types: enum$<core::option::Option<isize> >,enum$<core::option::Option<ref$<type_names::mod1::Struct2> >, 1, [...], Some>
247 // cdb-command:dx Debugger.State.Scripts.@"type-names.cdb".Contents.getFunctionDetails("rust_fn_with_return_value")
248 // cdb-check:Return Type: usize
249 // cdb-check:Parameter Types: f64
250 // cdb-command:dx Debugger.State.Scripts.@"type-names.cdb".Contents.getFunctionDetails("extern_c_fn_with_return_value")
251 // cdb-check:Return Type: type_names::Struct1
252 // cdb-check:Parameter Types:
253
254 // CLOSURES
255 // cdb-command:dv /t closure*
256 // cdb-check:struct tuple$<type_names::main::closure_env$1,usize> closure2 = [...]
257 // cdb-check:struct tuple$<type_names::main::closure_env$0,usize> closure1 = [...]
258
259 // FOREIGN TYPES
260 // cdb-command:dv /t foreign*
261 // cdb-check:struct type_names::mod1::extern$0::ForeignType2 * foreign2 = [...]
262 // cdb-check:struct type_names::extern$0::ForeignType1 * foreign1 = [...]
263
264 #![allow(unused_variables)]
265 #![feature(omit_gdb_pretty_printer_section)]
266 #![omit_gdb_pretty_printer_section]
267 #![feature(extern_types)]
268
269 use self::Enum1::{Variant1, Variant2};
270 use std::marker::PhantomData;
271 use std::ptr;
272
273 pub struct Struct1;
274 struct GenericStruct<T1, T2>(PhantomData<(T1, T2)>);
275
276 enum Enum1 {
277     Variant1,
278     Variant2(isize),
279 }
280
281 extern "C" {
282     type ForeignType1;
283 }
284
285 mod mod1 {
286     pub struct Struct2;
287
288     pub enum Enum2 {
289         Variant1,
290         Variant2(super::Struct1),
291     }
292
293     pub mod mod2 {
294         pub use self::Enum3::{Variant1, Variant2};
295         pub struct Struct3;
296
297         pub enum Enum3<T> {
298             Variant1,
299             Variant2(T),
300         }
301     }
302
303     extern "C" {
304         pub type ForeignType2;
305     }
306 }
307
308 trait Trait1 {
309     fn dummy(&self) {}
310 }
311 trait Trait2<T1, T2> {
312     fn dummy(&self, _: T1, _: T2) {}
313 }
314 trait Trait3<T> {
315     type AssocType;
316     fn dummy(&self) -> T {
317         panic!()
318     }
319 }
320
321 impl Trait1 for isize {}
322 impl<T1, T2> Trait2<T1, T2> for isize {}
323 impl<T> Trait3<T> for isize {
324     type AssocType = isize;
325 }
326
327 fn rust_fn(_: Option<isize>, _: Option<&mod1::Struct2>) {}
328 extern "C" fn extern_c_fn(_: isize) {}
329 unsafe fn unsafe_fn(_: Result<char, f64>) {}
330
331 fn rust_fn_with_return_value(_: f64) -> usize {
332     4
333 }
334 extern "C" fn extern_c_fn_with_return_value() -> Struct1 {
335     Struct1
336 }
337 unsafe fn unsafe_fn_with_return_value(_: GenericStruct<u16, u8>) -> mod1::Struct2 {
338     mod1::Struct2
339 }
340
341 fn generic_function<T>(x: T) -> T {
342     x
343 }
344
345 #[allow(improper_ctypes)]
346 extern "C" {
347     fn printf(_: *const u8, ...) -> isize;
348 }
349
350 // In many of the cases below, the type that is actually under test is wrapped
351 // in a tuple, e.g., Box<T>, references, raw pointers, fixed-size vectors, ...
352 // This is because GDB will not print the type name from DWARF debuginfo for
353 // some kinds of types (pointers, arrays, functions, ...)
354 // Since tuples are structs as far as GDB is concerned, their name will be
355 // printed correctly, so the tests below just construct a tuple type that will
356 // then *contain* the type name that we want to see.
357 fn main() {
358     // Structs
359     let simple_struct = Struct1;
360     let generic_struct1: GenericStruct<mod1::Struct2, mod1::mod2::Struct3> =
361         GenericStruct(PhantomData);
362     let generic_struct2: GenericStruct<Struct1, extern "fastcall" fn(isize) -> usize> =
363         GenericStruct(PhantomData);
364     let mod_struct = mod1::Struct2;
365
366     // Enums
367     let simple_enum_1 = Variant1;
368     let simple_enum_2 = Variant2(0);
369     let simple_enum_3 = mod1::Enum2::Variant2(Struct1);
370
371     let generic_enum_1: mod1::mod2::Enum3<mod1::Struct2> = mod1::mod2::Variant1;
372     let generic_enum_2 = mod1::mod2::Variant2(Struct1);
373
374     // Tuples
375     let tuple1 = (8u32, Struct1, mod1::mod2::Variant2(mod1::Struct2));
376     let tuple2 = ((Struct1, mod1::mod2::Struct3), mod1::Enum2::Variant1, 'x');
377
378     // Box
379     let box1 = (Box::new(1f32), 0i32);
380     let box2 = (Box::new(mod1::mod2::Variant2(1f32)), 0i32);
381
382     // References
383     let ref1 = (&Struct1, 0i32);
384     let ref2 = (&GenericStruct::<char, Struct1>(PhantomData), 0i32);
385
386     let mut mut_struct1 = Struct1;
387     let mut mut_generic_struct = GenericStruct::<mod1::Enum2, f64>(PhantomData);
388     let mut_ref1 = (&mut mut_struct1, 0i32);
389     let mut_ref2 = (&mut mut_generic_struct, 0i32);
390
391     // Raw Pointers
392     let mut_ptr1: (*mut Struct1, isize) = (ptr::null_mut(), 0);
393     let mut_ptr2: (*mut isize, isize) = (ptr::null_mut(), 0);
394     let mut_ptr3: (*mut mod1::mod2::Enum3<Struct1>, isize) = (ptr::null_mut(), 0);
395
396     let const_ptr1: (*const Struct1, isize) = (ptr::null(), 0);
397     let const_ptr2: (*const isize, isize) = (ptr::null(), 0);
398     let const_ptr3: (*const mod1::mod2::Enum3<Struct1>, isize) = (ptr::null(), 0);
399
400     // Vectors
401     let fixed_size_vec1 = ([Struct1, Struct1, Struct1], 0i16);
402     let fixed_size_vec2 = ([0_usize, 1, 2], 0i16);
403
404     let vec1 = vec![0_usize, 2, 3];
405     let slice1 = &*vec1;
406     let vec2 = vec![mod1::Enum2::Variant2(Struct1)];
407     let slice2 = &*vec2;
408
409     // Trait Objects
410     let box_trait = Box::new(0_isize) as Box<dyn Trait1>;
411     let ref_trait = &0_isize as &dyn Trait1;
412     let mut mut_int1 = 0_isize;
413     let mut_ref_trait = (&mut mut_int1) as &mut dyn Trait1;
414     let no_principal_trait = Box::new(0_isize) as Box<(dyn Send + Sync)>;
415     let has_associated_type_trait = &0_isize as &(dyn Trait3<u32, AssocType = isize> + Send);
416
417     let generic_box_trait = Box::new(0_isize) as Box<dyn Trait2<i32, mod1::Struct2>>;
418     let generic_ref_trait = (&0_isize) as &dyn Trait2<Struct1, Struct1>;
419
420     let mut generic_mut_ref_trait_impl = 0_isize;
421     let generic_mut_ref_trait = (&mut generic_mut_ref_trait_impl)
422         as &mut dyn Trait2<mod1::mod2::Struct3, GenericStruct<usize, isize>>;
423
424     // Bare Functions
425     let rust_fn = (rust_fn, 0_usize);
426     let extern_c_fn = (extern_c_fn, 0_usize);
427     let unsafe_fn = (unsafe_fn, 0_usize);
428
429     let rust_fn_with_return_value = (rust_fn_with_return_value, 0_usize);
430     let extern_c_fn_with_return_value = (extern_c_fn_with_return_value, 0_usize);
431     let unsafe_fn_with_return_value = (unsafe_fn_with_return_value, 0_usize);
432
433     let generic_function_int = (generic_function::<isize>, 0_usize);
434     let generic_function_struct3 = (generic_function::<mod1::mod2::Struct3>, 0_usize);
435
436     let variadic_function = (printf, 0_usize);
437
438     // Closures
439     // I (mw) am a bit unclear about the current state of closures, their
440     // various forms (boxed, unboxed, proc, capture-by-ref, by-val, once) and
441     // how that maps to rustc's internal representation of these forms.
442     // Once closures have reached their 1.0 form, the tests below should
443     // probably be expanded.
444     let closure1 = (|x: isize| {}, 0_usize);
445     let closure2 = (|x: i8, y: f32| (x as f32) + y, 0_usize);
446
447     // Foreign Types
448     let foreign1 = unsafe { 0 as *const ForeignType1 };
449     let foreign2 = unsafe { 0 as *const mod1::ForeignType2 };
450
451     zzz(); // #break
452 }
453
454 #[inline(never)]
455 fn zzz() {
456     ()
457 }