1 //! Handling of everything related to debuginfo.
9 use rustc_index::vec::IndexVec;
11 use cranelift_codegen::entity::EntityRef;
12 use cranelift_codegen::ir::{LabelValueLoc, StackSlots, ValueLabel, ValueLoc};
13 use cranelift_codegen::isa::TargetIsa;
14 use cranelift_codegen::ValueLocRange;
17 Address, AttributeValue, DwarfUnit, Expression, LineProgram, LineString, Location,
18 LocationList, Range, RangeList, UnitEntryId,
20 use gimli::{Encoding, Format, LineEncoding, RunTimeEndian, X86_64};
22 pub(crate) use emit::{DebugReloc, DebugRelocName};
23 pub(crate) use unwind::UnwindContext;
25 fn target_endian(tcx: TyCtxt<'_>) -> RunTimeEndian {
26 use rustc_target::abi::Endian;
28 match tcx.data_layout.endian {
29 Endian::Big => RunTimeEndian::Big,
30 Endian::Little => RunTimeEndian::Little,
34 pub(crate) struct DebugContext<'tcx> {
37 endian: RunTimeEndian,
40 unit_range_list: RangeList,
42 types: FxHashMap<Ty<'tcx>, UnitEntryId>,
45 impl<'tcx> DebugContext<'tcx> {
46 pub(crate) fn new(tcx: TyCtxt<'tcx>, isa: &dyn TargetIsa) -> Self {
47 let encoding = Encoding {
48 format: Format::Dwarf32,
49 // FIXME this should be configurable
50 // macOS doesn't seem to support DWARF > 3
51 // 5 version is required for md5 file hash
52 version: if tcx.sess.target.is_like_osx {
55 // FIXME change to version 5 once the gdb and lldb shipping with the latest debian
59 address_size: isa.frontend_config().pointer_bytes(),
62 let mut dwarf = DwarfUnit::new(encoding);
64 let producer = format!(
65 "cg_clif (rustc {}, cranelift {})",
66 rustc_interface::util::version_str().unwrap_or("unknown version"),
67 cranelift_codegen::VERSION,
69 let comp_dir = tcx.sess.opts.working_dir.to_string_lossy(false).into_owned();
70 let (name, file_info) = match tcx.sess.local_crate_source_file.clone() {
72 let name = path.to_string_lossy().into_owned();
75 None => (tcx.crate_name(LOCAL_CRATE).to_string(), None),
78 let mut line_program = LineProgram::new(
80 LineEncoding::default(),
81 LineString::new(comp_dir.as_bytes(), encoding, &mut dwarf.line_strings),
82 LineString::new(name.as_bytes(), encoding, &mut dwarf.line_strings),
85 line_program.file_has_md5 = file_info.is_some();
87 dwarf.unit.line_program = line_program;
90 let name = dwarf.strings.add(name);
91 let comp_dir = dwarf.strings.add(comp_dir);
93 let root = dwarf.unit.root();
94 let root = dwarf.unit.get_mut(root);
95 root.set(gimli::DW_AT_producer, AttributeValue::StringRef(dwarf.strings.add(producer)));
96 root.set(gimli::DW_AT_language, AttributeValue::Language(gimli::DW_LANG_Rust));
97 root.set(gimli::DW_AT_name, AttributeValue::StringRef(name));
98 root.set(gimli::DW_AT_comp_dir, AttributeValue::StringRef(comp_dir));
99 root.set(gimli::DW_AT_low_pc, AttributeValue::Address(Address::Constant(0)));
105 endian: target_endian(tcx),
108 unit_range_list: RangeList(Vec::new()),
110 types: FxHashMap::default(),
114 fn dwarf_ty(&mut self, ty: Ty<'tcx>) -> UnitEntryId {
115 if let Some(type_id) = self.types.get(ty) {
119 let new_entry = |dwarf: &mut DwarfUnit, tag| dwarf.unit.add(dwarf.unit.root(), tag);
121 let primitive = |dwarf: &mut DwarfUnit, ate| {
122 let type_id = new_entry(dwarf, gimli::DW_TAG_base_type);
123 let type_entry = dwarf.unit.get_mut(type_id);
124 type_entry.set(gimli::DW_AT_encoding, AttributeValue::Encoding(ate));
128 let name = format!("{}", ty);
129 let layout = self.tcx.layout_of(ParamEnv::reveal_all().and(ty)).unwrap();
131 let type_id = match ty.kind() {
132 ty::Bool => primitive(&mut self.dwarf, gimli::DW_ATE_boolean),
133 ty::Char => primitive(&mut self.dwarf, gimli::DW_ATE_UTF),
134 ty::Uint(_) => primitive(&mut self.dwarf, gimli::DW_ATE_unsigned),
135 ty::Int(_) => primitive(&mut self.dwarf, gimli::DW_ATE_signed),
136 ty::Float(_) => primitive(&mut self.dwarf, gimli::DW_ATE_float),
137 ty::Ref(_, pointee_ty, _mutbl)
138 | ty::RawPtr(ty::TypeAndMut { ty: pointee_ty, mutbl: _mutbl }) => {
139 let type_id = new_entry(&mut self.dwarf, gimli::DW_TAG_pointer_type);
141 // Ensure that type is inserted before recursing to avoid duplicates
142 self.types.insert(ty, type_id);
144 let pointee = self.dwarf_ty(pointee_ty);
146 let type_entry = self.dwarf.unit.get_mut(type_id);
148 //type_entry.set(gimli::DW_AT_mutable, AttributeValue::Flag(mutbl == rustc_hir::Mutability::Mut));
149 type_entry.set(gimli::DW_AT_type, AttributeValue::UnitRef(pointee));
153 ty::Adt(adt_def, _substs) if adt_def.is_struct() && !layout.is_unsized() => {
154 let type_id = new_entry(&mut self.dwarf, gimli::DW_TAG_structure_type);
156 // Ensure that type is inserted before recursing to avoid duplicates
157 self.types.insert(ty, type_id);
159 let variant = adt_def.non_enum_variant();
161 for (field_idx, field_def) in variant.fields.iter().enumerate() {
162 let field_offset = layout.fields.offset(field_idx);
163 let field_layout = layout
165 &layout::LayoutCx { tcx: self.tcx, param_env: ParamEnv::reveal_all() },
170 let field_type = self.dwarf_ty(field_layout.ty);
172 let field_id = self.dwarf.unit.add(type_id, gimli::DW_TAG_member);
173 let field_entry = self.dwarf.unit.get_mut(field_id);
177 AttributeValue::String(field_def.ident.as_str().to_string().into_bytes()),
180 gimli::DW_AT_data_member_location,
181 AttributeValue::Udata(field_offset.bytes()),
183 field_entry.set(gimli::DW_AT_type, AttributeValue::UnitRef(field_type));
188 _ => new_entry(&mut self.dwarf, gimli::DW_TAG_structure_type),
191 let type_entry = self.dwarf.unit.get_mut(type_id);
193 type_entry.set(gimli::DW_AT_name, AttributeValue::String(name.into_bytes()));
194 type_entry.set(gimli::DW_AT_byte_size, AttributeValue::Udata(layout.size.bytes()));
196 self.types.insert(ty, type_id);
201 fn define_local(&mut self, scope: UnitEntryId, name: String, ty: Ty<'tcx>) -> UnitEntryId {
202 let dw_ty = self.dwarf_ty(ty);
204 let var_id = self.dwarf.unit.add(scope, gimli::DW_TAG_variable);
205 let var_entry = self.dwarf.unit.get_mut(var_id);
207 var_entry.set(gimli::DW_AT_name, AttributeValue::String(name.into_bytes()));
208 var_entry.set(gimli::DW_AT_type, AttributeValue::UnitRef(dw_ty));
213 pub(crate) fn define_function(
215 instance: Instance<'tcx>,
220 source_info_set: &indexmap::IndexSet<SourceInfo>,
221 local_map: IndexVec<mir::Local, CPlace<'tcx>>,
223 let symbol = func_id.as_u32() as usize;
224 let mir = self.tcx.instance_mir(instance.def);
226 // FIXME: add to appropriate scope instead of root
227 let scope = self.dwarf.unit.root();
229 let entry_id = self.dwarf.unit.add(scope, gimli::DW_TAG_subprogram);
230 let entry = self.dwarf.unit.get_mut(entry_id);
231 let name_id = self.dwarf.strings.add(name);
232 // Gdb requires DW_AT_name. Otherwise the DW_TAG_subprogram is skipped.
233 entry.set(gimli::DW_AT_name, AttributeValue::StringRef(name_id));
234 entry.set(gimli::DW_AT_linkage_name, AttributeValue::StringRef(name_id));
236 let end = self.create_debug_lines(symbol, entry_id, context, mir.span, source_info_set);
238 self.unit_range_list.0.push(Range::StartLength {
239 begin: Address::Symbol { symbol, addend: 0 },
240 length: u64::from(end),
243 let func_entry = self.dwarf.unit.get_mut(entry_id);
244 // Gdb requires both DW_AT_low_pc and DW_AT_high_pc. Otherwise the DW_TAG_subprogram is skipped.
247 AttributeValue::Address(Address::Symbol { symbol, addend: 0 }),
249 // Using Udata for DW_AT_high_pc requires at least DWARF4
250 func_entry.set(gimli::DW_AT_high_pc, AttributeValue::Udata(u64::from(end)));
252 // FIXME make it more reliable and implement scopes before re-enabling this.
254 let value_labels_ranges = context.build_value_labels_ranges(isa).unwrap();
256 for (local, _local_decl) in mir.local_decls.iter_enumerated() {
257 let ty = self.tcx.subst_and_normalize_erasing_regions(
259 ty::ParamEnv::reveal_all(),
260 mir.local_decls[local].ty,
262 let var_id = self.define_local(entry_id, format!("{:?}", local), ty);
264 let location = place_location(
270 &value_labels_ranges,
271 Place { local, projection: ty::List::empty() },
274 let var_entry = self.dwarf.unit.get_mut(var_id);
275 var_entry.set(gimli::DW_AT_location, location);
279 // FIXME create locals for all entries in mir.var_debug_info
283 fn place_location<'tcx>(
284 debug_context: &mut DebugContext<'tcx>,
288 local_map: &IndexVec<mir::Local, CPlace<'tcx>>,
289 #[allow(rustc::default_hash_types)] value_labels_ranges: &std::collections::HashMap<
294 ) -> AttributeValue {
295 assert!(place.projection.is_empty()); // FIXME implement them
297 match local_map[place.local].inner() {
298 CPlaceInner::Var(_local, var) => {
299 let value_label = cranelift_codegen::ir::ValueLabel::new(var.index());
300 if let Some(value_loc_ranges) = value_labels_ranges.get(&value_label) {
301 let loc_list = LocationList(
304 .map(|value_loc_range| Location::StartEnd {
305 begin: Address::Symbol {
307 addend: i64::from(value_loc_range.start),
309 end: Address::Symbol { symbol, addend: i64::from(value_loc_range.end) },
313 &context.func.stack_slots,
319 let loc_list_id = debug_context.dwarf.unit.locations.add(loc_list);
321 AttributeValue::LocationListRef(loc_list_id)
323 // FIXME set value labels for unused locals
325 AttributeValue::Exprloc(Expression::new())
328 CPlaceInner::VarPair(_, _, _) => {
329 // FIXME implement this
331 AttributeValue::Exprloc(Expression::new())
333 CPlaceInner::VarLane(_, _, _) => {
334 // FIXME implement this
336 AttributeValue::Exprloc(Expression::new())
338 CPlaceInner::Addr(_, _) => {
339 // FIXME implement this (used by arguments and returns)
341 AttributeValue::Exprloc(Expression::new())
343 // For PointerBase::Stack:
344 //AttributeValue::Exprloc(translate_loc(ValueLoc::Stack(*stack_slot), &context.func.stack_slots).unwrap())
349 // Adapted from https://github.com/CraneStation/wasmtime/blob/5a1845b4caf7a5dba8eda1fef05213a532ed4259/crates/debug/src/transform/expression.rs#L59-L137
353 stack_slots: &StackSlots,
354 ) -> Option<Expression> {
356 LabelValueLoc::ValueLoc(ValueLoc::Reg(reg)) => {
357 let machine_reg = isa.map_dwarf_register(reg).unwrap();
358 let mut expr = Expression::new();
359 expr.op_reg(gimli::Register(machine_reg));
362 LabelValueLoc::ValueLoc(ValueLoc::Stack(ss)) => {
363 if let Some(ss_offset) = stack_slots[ss].offset {
364 let mut expr = Expression::new();
365 expr.op_breg(X86_64::RBP, i64::from(ss_offset) + 16);
371 LabelValueLoc::ValueLoc(ValueLoc::Unassigned) => unreachable!(),
372 LabelValueLoc::Reg(reg) => {
373 let machine_reg = isa.map_regalloc_reg_to_dwarf(reg).unwrap();
374 let mut expr = Expression::new();
375 expr.op_reg(gimli::Register(machine_reg));
378 LabelValueLoc::SPOffset(offset) => {
379 let mut expr = Expression::new();
380 expr.op_breg(X86_64::RSP, offset);