rust/src/debuginfo.rs

extern crate gimli;

use crate::prelude::*;

use std::marker::PhantomData;

use gimli::write::{
    Address, AttributeValue, CompilationUnit, DebugAbbrev, DebugInfo, DebugLine, DebugRanges,
    DebugRngLists, DebugStr, EndianVec, LineProgram, LineProgramId, LineProgramTable, Range,
    RangeList, RangesTable, Result, SectionId, StringTable, UnitEntryId, UnitId, UnitTable, Writer,
};
use gimli::Format;

// FIXME: use target endian
use byteorder::ByteOrder;
use gimli::RunTimeEndian;

use faerie::*;

fn target_endian(tcx: TyCtxt) -> RunTimeEndian {
    use rustc::ty::layout::Endian;

    match tcx.data_layout.endian {
        Endian::Big => RunTimeEndian::Big,
        Endian::Little => RunTimeEndian::Little,
    }
}
struct DebugReloc {
    offset: u32,
    size: u8,
    name: String,
    addend: i64,
}

pub struct DebugContext<'tcx> {
    endian: RunTimeEndian,
    format: Format,
    version: u16,
    address_size: u8,

    strings: StringTable,
    units: UnitTable,
    unit_id: UnitId,
    line_programs: LineProgramTable,
    global_line_program: LineProgramId,
    ranges: RangesTable,
    unit_ranges: RangeList,
    symbol_names: Vec<String>,

    _dummy: PhantomData<&'tcx ()>,
}

impl<'a, 'tcx: 'a> DebugContext<'tcx> {
    pub fn new(tcx: TyCtxt, address_size: u8) -> Self {
        // TODO: this should be configurable
        let version = 4;
        let format = Format::Dwarf32;

        // FIXME: how to get version when building out of tree?
        // Normally this would use option_env!("CFG_VERSION").
        let producer = format!("cranelift fn (rustc version {})", "unknown version");
        let comp_dir = tcx.sess.working_dir.0.to_string_lossy().into_owned();
        let name = match tcx.sess.local_crate_source_file {
            Some(ref path) => path.to_string_lossy().into_owned(),
            None => tcx.crate_name(LOCAL_CRATE).to_string(),
        };

        let mut units = UnitTable::default();
        let mut strings = StringTable::default();
        let mut line_programs = LineProgramTable::default();
        let ranges = RangesTable::default();

        let global_line_program = line_programs.add(LineProgram::new(
            version,
            address_size,
            format,
            1,
            1,
            -5,
            14,
            comp_dir.as_bytes(),
            name.as_bytes(),
            None,
        ));

        let unit_id = units.add(CompilationUnit::new(version, address_size, format));
        {
            let name = strings.add(&*name);
            let comp_dir = strings.add(&*comp_dir);

            let unit = units.get_mut(unit_id);
            let root = unit.root();
            let root = unit.get_mut(root);
            root.set(
                gimli::DW_AT_producer,
                AttributeValue::StringRef(strings.add(producer)),
            );
            root.set(
                gimli::DW_AT_language,
                AttributeValue::Language(gimli::DW_LANG_Rust),
            );
            root.set(gimli::DW_AT_name, AttributeValue::StringRef(name));
            root.set(gimli::DW_AT_comp_dir, AttributeValue::StringRef(comp_dir));
            root.set(
                gimli::DW_AT_stmt_list,
                AttributeValue::LineProgramRef(global_line_program),
            );
            root.set(
                gimli::DW_AT_low_pc,
                AttributeValue::Address(Address::Absolute(0)),
            );
        }

        DebugContext {
            endian: target_endian(tcx),
            format,
            version,
            address_size,

            strings,
            units,
            unit_id,
            line_programs,
            global_line_program,
            ranges,
            unit_ranges: RangeList(Vec::new()),
            symbol_names: Vec::new(),
            _dummy: PhantomData,
        }
    }

    fn emit_location(&mut self, tcx: TyCtxt<'a, 'tcx, 'tcx>, entry_id: UnitEntryId, span: Span) {
        let loc = tcx.sess.source_map().lookup_char_pos(span.lo());

        let unit = self.units.get_mut(self.unit_id);
        let entry = unit.get_mut(entry_id);

        let file_id = self.strings.add(loc.file.name.to_string());
        entry.set(gimli::DW_AT_decl_file, AttributeValue::StringRef(file_id));
        entry.set(
            gimli::DW_AT_decl_line,
            AttributeValue::Udata(loc.line as u64),
        );
        // FIXME: probably omit this
        entry.set(
            gimli::DW_AT_decl_column,
            AttributeValue::Udata(loc.col.to_usize() as u64),
        );
    }

    pub fn emit(&mut self, artifact: &mut Artifact) {
        let unit_range_id = self.ranges.add(self.unit_ranges.clone());
        let unit = self.units.get_mut(self.unit_id);
        let root = unit.root();
        let root = unit.get_mut(root);
        root.set(
            gimli::DW_AT_ranges,
            AttributeValue::RangeListsRef(unit_range_id),
        );

        let mut debug_abbrev = DebugAbbrev::from(WriterRelocate::new(self));
        let mut debug_info = DebugInfo::from(WriterRelocate::new(self));
        let mut debug_str = DebugStr::from(WriterRelocate::new(self));
        let mut debug_line = DebugLine::from(WriterRelocate::new(self));
        let mut debug_ranges = DebugRanges::from(WriterRelocate::new(self));
        let mut debug_rnglists = DebugRngLists::from(WriterRelocate::new(self));

        let debug_line_offsets = self.line_programs.write(&mut debug_line).unwrap();
        let debug_str_offsets = self.strings.write(&mut debug_str).unwrap();
        let (debug_ranges_offsets, debug_rnglists_offsets) = self
            .ranges
            .write(
                &mut debug_ranges,
                &mut debug_rnglists,
                self.format,
                self.version,
                self.address_size,
            )
            .unwrap();
        self.units
            .write(
                &mut debug_abbrev,
                &mut debug_info,
                &debug_line_offsets,
                &debug_ranges_offsets,
                &debug_rnglists_offsets,
                &debug_str_offsets,
            )
            .unwrap();

        artifact
            .declare_with(
                SectionId::DebugAbbrev.name(),
                Decl::DebugSection,
                debug_abbrev.0.writer.into_vec(),
            )
            .unwrap();
        artifact
            .declare_with(
                SectionId::DebugInfo.name(),
                Decl::DebugSection,
                debug_info.0.writer.into_vec(),
            )
            .unwrap();
        artifact
            .declare_with(
                SectionId::DebugStr.name(),
                Decl::DebugSection,
                debug_str.0.writer.into_vec(),
            )
            .unwrap();
        artifact
            .declare_with(
                SectionId::DebugLine.name(),
                Decl::DebugSection,
                debug_line.0.writer.into_vec(),
            )
            .unwrap();
        artifact
            .declare_with(
                SectionId::DebugRanges.name(),
                Decl::DebugSection,
                debug_ranges.0.writer.into_vec(),
            )
            .unwrap();
        artifact
            .declare_with(
                SectionId::DebugRngLists.name(),
                Decl::DebugSection,
                debug_rnglists.0.writer.into_vec(),
            )
            .unwrap();

        for reloc in debug_abbrev.0.relocs {
            artifact
                .link_with(
                    faerie::Link {
                        from: SectionId::DebugAbbrev.name(),
                        to: &reloc.name,
                        at: u64::from(reloc.offset),
                    },
                    faerie::Reloc::Debug {
                        size: reloc.size,
                        addend: reloc.addend as i32,
                    },
                )
                .expect("faerie relocation error");
        }

        for reloc in debug_info.0.relocs {
            artifact
                .link_with(
                    faerie::Link {
                        from: SectionId::DebugInfo.name(),
                        to: &reloc.name,
                        at: u64::from(reloc.offset),
                    },
                    faerie::Reloc::Debug {
                        size: reloc.size,
                        addend: reloc.addend as i32,
                    },
                )
                .expect("faerie relocation error");
        }

        for reloc in debug_str.0.relocs {
            artifact
                .link_with(
                    faerie::Link {
                        from: SectionId::DebugStr.name(),
                        to: &reloc.name,
                        at: u64::from(reloc.offset),
                    },
                    faerie::Reloc::Debug {
                        size: reloc.size,
                        addend: reloc.addend as i32,
                    },
                )
                .expect("faerie relocation error");
        }

        for reloc in debug_line.0.relocs {
            artifact
                .link_with(
                    faerie::Link {
                        from: SectionId::DebugLine.name(),
                        to: &reloc.name,
                        at: u64::from(reloc.offset),
                    },
                    faerie::Reloc::Debug {
                        size: reloc.size,
                        addend: reloc.addend as i32,
                    },
                )
                .expect("faerie relocation error");
        }

        for reloc in debug_ranges.0.relocs {
            artifact
                .link_with(
                    faerie::Link {
                        from: SectionId::DebugRanges.name(),
                        to: &reloc.name,
                        at: u64::from(reloc.offset),
                    },
                    faerie::Reloc::Debug {
                        size: reloc.size,
                        addend: reloc.addend as i32,
                    },
                )
                .expect("faerie relocation error");
        }

        for reloc in debug_rnglists.0.relocs {
            artifact
                .link_with(
                    faerie::Link {
                        from: SectionId::DebugRngLists.name(),
                        to: &reloc.name,
                        at: u64::from(reloc.offset),
                    },
                    faerie::Reloc::Debug {
                        size: reloc.size,
                        addend: reloc.addend as i32,
                    },
                )
                .expect("faerie relocation error");
        }
    }

    fn section_name(&self, id: SectionId) -> String {
        id.name().to_string()
    }
}

pub struct FunctionDebugContext<'a, 'tcx> {
    debug_context: &'a mut DebugContext<'tcx>,
    entry_id: UnitEntryId,
    symbol: usize,
    mir_span: Span,
}

impl<'a, 'b, 'tcx: 'b> FunctionDebugContext<'a, 'tcx> {
    pub fn new(
        tcx: TyCtxt<'b, 'tcx, 'tcx>,
        debug_context: &'a mut DebugContext<'tcx>,
        mir: &Mir,
        name: &str,
        _sig: &Signature,
    ) -> Self {
        let symbol = debug_context.symbol_names.len();
        debug_context.symbol_names.push(name.to_string());

        let unit = debug_context.units.get_mut(debug_context.unit_id);
        // FIXME: add to appropriate scope intead of root
        let scope = unit.root();

        let entry_id = unit.add(scope, gimli::DW_TAG_subprogram);
        let entry = unit.get_mut(entry_id);
        let name_id = debug_context.strings.add(name);
        entry.set(
            gimli::DW_AT_linkage_name,
            AttributeValue::StringRef(name_id),
        );

        entry.set(
            gimli::DW_AT_low_pc,
            AttributeValue::Address(Address::Relative { symbol, addend: 0 }),
        );

        debug_context.emit_location(tcx, entry_id, mir.span);

        FunctionDebugContext {
            debug_context,
            entry_id,
            symbol,
            mir_span: mir.span,
        }
    }

    pub fn define(
        &mut self,
        tcx: TyCtxt,
        //module: &mut Module<impl Backend>,
        size: u32,
        context: &Context,
        isa: &cranelift::codegen::isa::TargetIsa,
        spans: &[Span],
    ) {
        let unit = self.debug_context.units.get_mut(self.debug_context.unit_id);
        // FIXME: add to appropriate scope intead of root
        let entry = unit.get_mut(self.entry_id);
        let mut size_array = [0; 8];
        byteorder::LittleEndian::write_u64(&mut size_array, size as u64);
        entry.set(gimli::DW_AT_high_pc, AttributeValue::Data8(size_array));

        self.debug_context.unit_ranges.0.push(Range {
            begin: Address::Relative {
                symbol: self.symbol,
                addend: 0,
            },
            end: Address::Relative {
                symbol: self.symbol,
                addend: size as i64,
            },
        });

        let line_program = self
            .debug_context
            .line_programs
            .get_mut(self.debug_context.global_line_program);

        line_program.begin_sequence(Some(Address::Relative {
            symbol: self.symbol,
            addend: 0,
        }));

        let encinfo = isa.encoding_info();
        let func = &context.func;
        let mut ebbs = func.layout.ebbs().collect::<Vec<_>>();
        ebbs.sort_by_key(|ebb| func.offsets[*ebb]); // Ensure inst offsets always increase
        for ebb in ebbs {
            for (offset, inst, _size) in func.inst_offsets(ebb, &encinfo) {
                fn create_row_for_span(tcx: TyCtxt, line_program: &mut LineProgram, offset: u64, span: Span) {
                    let loc = tcx.sess.source_map().lookup_char_pos(span.lo());
                    let file = loc.file.name.to_string();
                    let file = ::std::path::Path::new(&file);
                    let dir_id = line_program
                        .add_directory(file.parent().unwrap().to_str().unwrap().as_bytes());
                    let file_id = line_program.add_file(
                        file.file_name().unwrap().to_str().unwrap().as_bytes(),
                        dir_id,
                        None,
                    );
                    line_program.row().file = file_id;
                    //tcx.sess
                    //    .warn(&format!("srcloc {} {}:{}:{}", offset, file, loc.line, loc.col.to_usize()));
                    line_program.row().address_offset = offset;
                    line_program.row().line = loc.line as u64;
                    line_program.generate_row();
                }

                let srcloc = func.srclocs[inst];
                if !srcloc.is_default() {
                    let span = spans[srcloc.bits() as usize];
                    create_row_for_span(tcx, line_program, offset as u64, span);
                } else {
                    create_row_for_span(tcx, line_program, offset as u64, self.mir_span);
                }
            }
        }

        let address_offset = line_program.row().address_offset;
        line_program.end_sequence(address_offset);
    }
}

struct WriterRelocate<'a, 'tcx> {
    ctx: &'a DebugContext<'tcx>,
    relocs: Vec<DebugReloc>,
    writer: EndianVec<RunTimeEndian>,
}

impl<'a, 'tcx> WriterRelocate<'a, 'tcx> {
    fn new(ctx: &'a DebugContext<'tcx>) -> Self {
        WriterRelocate {
            ctx,
            relocs: Vec::new(),
            writer: EndianVec::new(ctx.endian),
        }
    }
}

impl<'a, 'tcx> Writer for WriterRelocate<'a, 'tcx> {
    type Endian = RunTimeEndian;

    fn endian(&self) -> Self::Endian {
        self.writer.endian()
    }

    fn len(&self) -> usize {
        self.writer.len()
    }

    fn write(&mut self, bytes: &[u8]) -> Result<()> {
        self.writer.write(bytes)
    }

    fn write_at(&mut self, offset: usize, bytes: &[u8]) -> Result<()> {
        self.writer.write_at(offset, bytes)
    }

    fn write_address(&mut self, address: Address, size: u8) -> Result<()> {
        match address {
            Address::Absolute(val) => self.write_word(val, size),
            Address::Relative { symbol, addend } => {
                let offset = self.len() as u64;
                self.relocs.push(DebugReloc {
                    offset: offset as u32,
                    size,
                    name: self.ctx.symbol_names[symbol].clone(),
                    addend: addend as i64,
                });
                self.write_word(0, size)
            }
        }
    }

    fn write_offset(&mut self, val: usize, section: SectionId, size: u8) -> Result<()> {
        let offset = self.len() as u32;
        let name = self.ctx.section_name(section);
        self.relocs.push(DebugReloc {
            offset,
            size,
            name,
            addend: val as i64,
        });
        self.write_word(0, size)
    }

    fn write_offset_at(
        &mut self,
        offset: usize,
        val: usize,
        section: SectionId,
        size: u8,
    ) -> Result<()> {
        let name = self.ctx.section_name(section);
        self.relocs.push(DebugReloc {
            offset: offset as u32,
            size,
            name,
            addend: val as i64,
        });
        self.write_word_at(offset, 0, size)
    }
}