path: root/plugins/dwarf/dwarf_import/src/functions.rs

// Copyright 2021-2026 Vector 35 Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::sync::OnceLock;

use crate::dwarfdebuginfo::{DebugInfoBuilder, DebugInfoBuilderContext, TypeUID};
use crate::types::get_type;
use crate::{helpers::*, ReaderType};

use binaryninja::template_simplifier::simplify_str_to_str;
use cpp_demangle::DemangleOptions;
use gimli::{constants, AttributeValue, DebuggingInformationEntry, Dwarf, Operation, Unit};
use regex::Regex;

#[derive(PartialEq, Eq, Hash)]
pub enum FrameBase {
    Register(gimli::Register),
    CFA,
}

fn get_parameters<R: ReaderType>(
    dwarf: &Dwarf<R>,
    unit: &Unit<R>,
    entry: &DebuggingInformationEntry<R>,
    debug_info_builder_context: &DebugInfoBuilderContext<R>,
    debug_info_builder: &mut DebugInfoBuilder,
) -> (Vec<Option<(String, TypeUID)>>, bool) {
    if !entry.has_children() {
        return (vec![], false);
    }

    // We make a new tree from the current entry to iterate over its children
    let mut sub_die_tree = match unit.entries_tree(Some(entry.offset())) {
        Ok(x) => x,
        Err(e) => {
            tracing::error!("Failed to get function parameter entry tree: {}", e);
            return (vec![], false);
        }
    };
    let root = match sub_die_tree.root() {
        Ok(x) => x,
        Err(e) => {
            tracing::error!("Failed to get function parameter entry tree root: {}", e);
            return (vec![], false);
        }
    };

    let mut variable_arguments = false;
    let mut result = vec![];
    let mut children = root.children();
    while let Ok(Some(child)) = children.next() {
        match child.entry().tag() {
            constants::DW_TAG_formal_parameter => {
                //TODO: if the param type is a typedef to an anonymous struct (typedef struct {...} foo) then this is reoslved to an anonymous struct instead of foo
                //  We should still recurse to make sure we load all types this param type depends on, but
                let name = debug_info_builder_context.get_name(dwarf, unit, child.entry());

                let type_ = get_type(
                    dwarf,
                    unit,
                    child.entry(),
                    debug_info_builder_context,
                    debug_info_builder,
                );
                if let Some(parameter_name) = name {
                    if let Some(parameter_type) = type_ {
                        result.push(Some((parameter_name, parameter_type)));
                    } else {
                        result.push(Some((parameter_name, 0)))
                    }
                } else {
                    result.push(None)
                }
            }
            constants::DW_TAG_unspecified_parameters => variable_arguments = true,
            _ => (),
        }
    }
    (result, variable_arguments)
}

pub(crate) fn parse_function_entry<R: ReaderType>(
    dwarf: &Dwarf<R>,
    unit: &Unit<R>,
    entry: &DebuggingInformationEntry<R>,
    debug_info_builder_context: &DebugInfoBuilderContext<R>,
    debug_info_builder: &mut DebugInfoBuilder,
) -> Option<usize> {
    // Collect function properties (if they exist in this DIE)
    let raw_name = get_raw_name(dwarf, unit, entry, debug_info_builder_context);
    let return_type = get_type(
        dwarf,
        unit,
        entry,
        debug_info_builder_context,
        debug_info_builder,
    );
    let address = get_start_address(dwarf, unit, entry);
    let (parameters, variable_arguments) = get_parameters(
        dwarf,
        unit,
        entry,
        debug_info_builder_context,
        debug_info_builder,
    );

    // If we have a raw name, it might be mangled, see if we can demangle it into full_name
    //  raw_name should contain a superset of the info we have in full_name
    let mut full_name = None;
    if let Some(possibly_mangled_name) = &raw_name {
        if possibly_mangled_name.starts_with('_') {
            static OPTIONS_MEM: OnceLock<DemangleOptions> = OnceLock::new();
            let demangle_options = OPTIONS_MEM.get_or_init(|| {
                DemangleOptions::new()
                    .no_return_type()
                    .hide_expression_literal_types()
                    .no_params()
            });

            static ABI_REGEX_MEM: OnceLock<Regex> = OnceLock::new();
            let abi_regex = ABI_REGEX_MEM
                .get_or_init(|| Regex::new(r"\[abi:v\d+\]").expect("Failed to generate ABI regex"));
            if let Ok(sym) = cpp_demangle::Symbol::new(possibly_mangled_name) {
                if let Ok(demangled) = sym.demangle(demangle_options) {
                    let cleaned = abi_regex.replace_all(&demangled, "");
                    let simplified = simplify_str_to_str(&cleaned);
                    full_name = Some(simplified.to_string_lossy().to_string());
                }
            }
        }
    }

    // If we didn't demangle the raw name, fetch the name given
    if full_name.is_none() {
        full_name = debug_info_builder_context.get_name(dwarf, unit, entry)
    }

    if raw_name.is_none() && full_name.is_none() {
        tracing::debug!(
            "Function entry in DWARF without full or raw name: .debug_info offset {:?}",
            entry.offset().to_debug_info_offset(&unit.header)
        );
        return None;
    }

    let frame_base;
    if let Ok(Some(AttributeValue::Exprloc(mut expression))) =
        entry.attr_value(constants::DW_AT_frame_base)
    {
        frame_base = match Operation::parse(&mut expression.0, unit.encoding()) {
            Ok(Operation::Register { register: reg }) => Some(FrameBase::Register(reg)),
            Ok(Operation::CallFrameCFA) => Some(FrameBase::CFA),
            _ => None, // TODO: warn?
        };
    } else {
        frame_base = None;
    }

    debug_info_builder.insert_function(
        full_name,
        raw_name,
        return_type,
        address,
        &parameters,
        variable_arguments,
        frame_base,
    )
}

pub(crate) fn parse_lexical_block<R: ReaderType>(
    dwarf: &Dwarf<R>,
    unit: &Unit<R>,
    entry: &DebuggingInformationEntry<R>,
) -> Option<iset::IntervalSet<u64>> {
    // Return lexical block ranges
    // Must have either DW_AT_ranges or DW_AT_low_pc and DW_AT_high_pc
    let mut result = iset::IntervalSet::new();
    if let Ok(Some(attr_value)) = entry.attr_value(constants::DW_AT_ranges) {
        if let Ok(Some(ranges_offset)) = dwarf.attr_ranges_offset(unit, attr_value) {
            if let Ok(mut ranges) = dwarf.ranges(unit, ranges_offset) {
                while let Ok(Some(range)) = ranges.next() {
                    // Ranges where start == end may be ignored (DWARFv5 spec, 2.17.3 line 17)
                    if range.begin == range.end {
                        continue;
                    }
                    result.insert(range.begin..range.end);
                }
            }
        }
    } else if let Ok(Some(low_pc_value)) = entry.attr_value(constants::DW_AT_low_pc) {
        let unit_base = match unit.header.offset().as_debug_info_offset() {
            Some(x) => x.0,
            None => {
                tracing::warn!("Unable to get unit offset in debug info: {:?}. This may be an indicator of parsing issues.", unit.header.offset());
                0
            }
        };

        let Ok(Some(low_pc)) = dwarf.attr_address(unit, low_pc_value.clone()) else {
            tracing::error!(
                "Failed to read lexical block low_pc for entry {:#x}, please report this bug.",
                unit_base + entry.offset().0
            );
            return None;
        };

        let Ok(Some(high_pc_value)) = entry.attr_value(constants::DW_AT_high_pc) else {
            tracing::error!("Failed to read lexical block high_pc attribute for entry {:#x}, please report this bug.", unit_base + entry.offset().0);
            return None;
        };

        let Some(high_pc) = high_pc_value
            .udata_value()
            .and_then(|x| Some(low_pc + x))
            .or_else(|| dwarf.attr_address(unit, high_pc_value).unwrap_or(None))
        else {
            tracing::error!(
                "Failed to read lexical block high_pc for entry {:#x}, please report this bug.",
                unit_base + entry.offset().0
            );
            return None;
        };

        // DWARFv5 spec section 2.17 allows for undefined behavior in cases where the object currently being referred to doesn't exist
        if low_pc == 0 && high_pc == 0 {
            return None;
        }

        if low_pc < high_pc {
            result.insert(low_pc..high_pc);
        } else if low_pc == high_pc {
            // Ranges where start == end may be ignored (DWARFv5 spec, 2.17.3 line 17)
            return None;
        } else {
            tracing::error!(
                "Invalid lexical block range: {:#x} -> {:#x}",
                low_pc,
                high_pc
            );
        }
    } else {
        // If neither case is hit the lexical block doesn't define any ranges and we should ignore it
        return None;
    }

    Some(result)
}