Version v3.0.0-beta.8

When searching for a symbol by name, only look at
symbols that are defined within the object,
ignoring extern symbols (symbols without section).

Fixes #180
Fixes #181

.cargo/config.toml

@@ -1,5 +1,4 @@
-[target.x86_64-pc-windows-msvc]
-linker = "rust-lld"
-
-[target.aarch64-pc-windows-msvc]
-linker = "rust-lld"
+# statically link the C runtime so the executable does not depend on
+# that shared/dynamic library.
+[target.'cfg(all(target_env = "msvc", target_os = "windows"))']
+rustflags = ["-C", "target-feature=+crt-static"]

Cargo.lock

@@ -3373,7 +3373,7 @@ dependencies = [
 
 [[package]]
 name = "objdiff-cli"
-version = "3.0.0-beta.7"
+version = "3.0.0-beta.8"
 dependencies = [
  "anyhow",
  "argp",
@@ -3396,7 +3396,7 @@ dependencies = [
 
 [[package]]
 name = "objdiff-core"
-version = "3.0.0-beta.7"
+version = "3.0.0-beta.8"
 dependencies = [
  "anyhow",
  "arm-attr",
@@ -3450,7 +3450,7 @@ dependencies = [
 
 [[package]]
 name = "objdiff-gui"
-version = "3.0.0-beta.7"
+version = "3.0.0-beta.8"
 dependencies = [
  "anyhow",
  "cfg-if",
@@ -3486,7 +3486,7 @@ dependencies = [
 
 [[package]]
 name = "objdiff-wasm"
-version = "3.0.0-beta.7"
+version = "3.0.0-beta.8"
 dependencies = [
  "log",
  "objdiff-core",

Cargo.toml

@@ -14,7 +14,7 @@ strip = "debuginfo"
 codegen-units = 1
 
 [workspace.package]
-version = "3.0.0-beta.7"
+version = "3.0.0-beta.8"
 authors = ["Luke Street <luke@street.dev>"]
 edition = "2024"
 license = "MIT OR Apache-2.0"

config.schema.json

@@ -175,6 +175,10 @@
           "type": "boolean",
           "description": "If true, objdiff will run the build command with the context file as an argument to generate it.",
           "default": false
+        },
+        "preset_id": {
+          "type": "number",
+          "description": "The decomp.me preset ID to use for the scratch.\nCompiler and flags in the config will take precedence over the preset, but the preset is useful for organizational purposes."
         }
       },
       "required": [

objdiff-cli/src/cmd/report.rs

@@ -245,12 +245,14 @@ fn report_object(
         for (symbol, symbol_diff) in obj.symbols.iter().zip(&obj_diff.symbols) {
             if symbol.section != Some(section_idx)
                 || symbol.size == 0
-                || symbol.flags.contains(SymbolFlag::Hidden | SymbolFlag::Ignored)
+                || symbol.flags.contains(SymbolFlag::Hidden)
+                || symbol.flags.contains(SymbolFlag::Ignored)
             {
                 continue;
             }
             if let Some(existing_functions) = &mut existing_functions {
-                if symbol.flags.contains(SymbolFlag::Global | SymbolFlag::Weak)
+                if (symbol.flags.contains(SymbolFlag::Global)
+                    || symbol.flags.contains(SymbolFlag::Weak))
                     && !existing_functions.insert(symbol.name.clone())
                 {
                     continue;

objdiff-cli/src/views/function_diff.rs

@@ -450,11 +450,11 @@ impl UiView for FunctionDiffUi {
 
     fn reload(&mut self, state: &AppState) -> Result<()> {
         let left_sym =
-            state.left_obj.as_ref().and_then(|(o, _)| find_function(o, &self.symbol_name));
+            state.left_obj.as_ref().and_then(|(o, _)| o.symbol_by_name(&self.symbol_name));
         let right_sym =
-            state.right_obj.as_ref().and_then(|(o, _)| find_function(o, &self.symbol_name));
+            state.right_obj.as_ref().and_then(|(o, _)| o.symbol_by_name(&self.symbol_name));
         let prev_sym =
-            state.prev_obj.as_ref().and_then(|(o, _)| find_function(o, &self.symbol_name));
+            state.prev_obj.as_ref().and_then(|(o, _)| o.symbol_by_name(&self.symbol_name));
         self.num_rows = match (
             get_symbol(state.left_obj.as_ref(), left_sym),
             get_symbol(state.right_obj.as_ref(), right_sym),
@@ -650,12 +650,3 @@ fn get_symbol(
     let sym = sym?;
     Some((obj, sym, &diff.symbols[sym]))
 }
-
-fn find_function(obj: &Object, name: &str) -> Option<usize> {
-    for (symbol_idx, symbol) in obj.symbols.iter().enumerate() {
-        if symbol.name == name {
-            return Some(symbol_idx);
-        }
-    }
-    None
-}

objdiff-core/src/arch/arm.rs

@@ -225,7 +225,7 @@ impl Arch for ArchArm {
 
         let mut address = start_addr;
         while address < end_addr {
-            while let Some(next) = next_mapping.take_if(|x| address >= x.address) {
+            while let Some(next) = next_mapping.filter(|x| address >= x.address) {
                 // Change mapping
                 mode = next.mapping;
                 next_mapping = mappings_iter.next();

objdiff-core/src/diff/display.rs

@@ -77,7 +77,7 @@ impl<'a> DiffTextSegment<'a> {
 const EOL_SEGMENT: DiffTextSegment<'static> =
     DiffTextSegment { text: DiffText::Eol, color: DiffTextColor::Normal, pad_to: 0 };
 
-#[derive(Debug, Default, Clone, PartialEq, Eq)]
+#[derive(Debug, Default, Clone)]
 pub enum HighlightKind {
     #[default]
     None,
@@ -288,6 +288,18 @@ pub fn display_row(
     Ok(())
 }
 
+impl PartialEq<HighlightKind> for HighlightKind {
+    fn eq(&self, other: &HighlightKind) -> bool {
+        match (self, other) {
+            (HighlightKind::Opcode(a), HighlightKind::Opcode(b)) => a == b,
+            (HighlightKind::Argument(a), HighlightKind::Argument(b)) => a.loose_eq(b),
+            (HighlightKind::Symbol(a), HighlightKind::Symbol(b)) => a == b,
+            (HighlightKind::Address(a), HighlightKind::Address(b)) => a == b,
+            _ => false,
+        }
+    }
+}
+
 impl PartialEq<DiffText<'_>> for HighlightKind {
     fn eq(&self, other: &DiffText) -> bool {
         match (self, other) {
@@ -604,7 +616,9 @@ fn symbol_matches_filter(
         return false;
     }
     if !show_hidden_symbols
-        && (symbol.size == 0 || symbol.flags.contains(SymbolFlag::Hidden | SymbolFlag::Ignored))
+        && (symbol.size == 0
+            || symbol.flags.contains(SymbolFlag::Hidden)
+            || symbol.flags.contains(SymbolFlag::Ignored))
     {
         return false;
     }

objdiff-core/src/diff/mod.rs

@@ -341,11 +341,25 @@ pub fn diff_objs(
     if let (Some((right_obj, right_out)), Some((left_obj, left_out))) =
         (right.as_mut(), left.as_mut())
     {
-        if let Some(right_name) = &mapping_config.selecting_left {
-            generate_mapping_symbols(right_obj, right_name, left_obj, left_out, diff_config)?;
+        if let Some(right_name) = mapping_config.selecting_left.as_deref() {
+            generate_mapping_symbols(
+                left_obj,
+                left_out,
+                right_obj,
+                right_out,
+                MappingSymbol::Right(right_name),
+                diff_config,
+            )?;
         }
-        if let Some(left_name) = &mapping_config.selecting_right {
-            generate_mapping_symbols(left_obj, left_name, right_obj, right_out, diff_config)?;
+        if let Some(left_name) = mapping_config.selecting_right.as_deref() {
+            generate_mapping_symbols(
+                left_obj,
+                left_out,
+                right_obj,
+                right_out,
+                MappingSymbol::Left(left_name),
+                diff_config,
+            )?;
         }
     }
 
@@ -356,17 +370,28 @@ pub fn diff_objs(
     })
 }
 
+#[derive(Clone, Copy)]
+enum MappingSymbol<'a> {
+    Left(&'a str),
+    Right(&'a str),
+}
+
 /// When we're selecting a symbol to use as a comparison, we'll create comparisons for all
 /// symbols in the other object that match the selected symbol's section and kind. This allows
 /// us to display match percentages for all symbols in the other object that could be selected.
 fn generate_mapping_symbols(
-    base_obj: &Object,
-    base_name: &str,
-    target_obj: &Object,
-    target_out: &mut ObjectDiff,
+    left_obj: &Object,
+    left_out: &mut ObjectDiff,
+    right_obj: &Object,
+    right_out: &mut ObjectDiff,
+    mapping_symbol: MappingSymbol,
     config: &DiffObjConfig,
 ) -> Result<()> {
-    let Some(base_symbol_ref) = symbol_ref_by_name(base_obj, base_name) else {
+    let (base_obj, base_name, target_obj) = match mapping_symbol {
+        MappingSymbol::Left(name) => (left_obj, name, right_obj),
+        MappingSymbol::Right(name) => (right_obj, name, left_obj),
+    };
+    let Some(base_symbol_ref) = base_obj.symbol_by_name(base_name) else {
         return Ok(());
     };
     let base_section_kind = symbol_section_kind(base_obj, &base_obj.symbols[base_symbol_ref]);
@@ -377,32 +402,30 @@ fn generate_mapping_symbols(
         {
             continue;
         }
-        match base_section_kind {
+        let (left_symbol_idx, right_symbol_idx) = match mapping_symbol {
+            MappingSymbol::Left(_) => (base_symbol_ref, target_symbol_index),
+            MappingSymbol::Right(_) => (target_symbol_index, base_symbol_ref),
+        };
+        let (left_diff, right_diff) = match base_section_kind {
             SectionKind::Code => {
-                let (left_diff, _right_diff) =
-                    diff_code(target_obj, base_obj, target_symbol_index, base_symbol_ref, config)?;
-                target_out.mapping_symbols.push(MappingSymbolDiff {
-                    symbol_index: target_symbol_index,
-                    symbol_diff: left_diff,
-                });
+                diff_code(left_obj, right_obj, left_symbol_idx, right_symbol_idx, config)
             }
             SectionKind::Data => {
-                let (left_diff, _right_diff) =
-                    diff_data_symbol(target_obj, base_obj, target_symbol_index, base_symbol_ref)?;
-                target_out.mapping_symbols.push(MappingSymbolDiff {
-                    symbol_index: target_symbol_index,
-                    symbol_diff: left_diff,
-                });
+                diff_data_symbol(left_obj, right_obj, left_symbol_idx, right_symbol_idx)
             }
             SectionKind::Bss | SectionKind::Common => {
-                let (left_diff, _right_diff) =
-                    diff_bss_symbol(target_obj, base_obj, target_symbol_index, base_symbol_ref)?;
-                target_out.mapping_symbols.push(MappingSymbolDiff {
-                    symbol_index: target_symbol_index,
-                    symbol_diff: left_diff,
-                });
+                diff_bss_symbol(left_obj, right_obj, left_symbol_idx, right_symbol_idx)
             }
-            SectionKind::Unknown => {}
+            SectionKind::Unknown => continue,
+        }?;
+        match mapping_symbol {
+            MappingSymbol::Left(_) => right_out.mapping_symbols.push(MappingSymbolDiff {
+                symbol_index: right_symbol_idx,
+                symbol_diff: right_diff,
+            }),
+            MappingSymbol::Right(_) => left_out
+                .mapping_symbols
+                .push(MappingSymbolDiff { symbol_index: left_symbol_idx, symbol_diff: left_diff }),
         }
     }
     Ok(())
@@ -434,10 +457,6 @@ pub struct MappingConfig {
     pub selecting_right: Option<String>,
 }
 
-fn symbol_ref_by_name(obj: &Object, name: &str) -> Option<usize> {
-    obj.symbols.iter().position(|s| s.name == name)
-}
-
 fn apply_symbol_mappings(
     left: &Object,
     right: &Object,
@@ -449,25 +468,25 @@ fn apply_symbol_mappings(
     // If we're selecting a symbol to use as a comparison, mark it as used
     // This ensures that we don't match it to another symbol at any point
     if let Some(left_name) = &mapping_config.selecting_left {
-        if let Some(left_symbol) = symbol_ref_by_name(left, left_name) {
+        if let Some(left_symbol) = left.symbol_by_name(left_name) {
             left_used.insert(left_symbol);
         }
     }
     if let Some(right_name) = &mapping_config.selecting_right {
-        if let Some(right_symbol) = symbol_ref_by_name(right, right_name) {
+        if let Some(right_symbol) = right.symbol_by_name(right_name) {
             right_used.insert(right_symbol);
         }
     }
 
     // Apply manual symbol mappings
     for (left_name, right_name) in &mapping_config.mappings {
-        let Some(left_symbol_index) = symbol_ref_by_name(left, left_name) else {
+        let Some(left_symbol_index) = left.symbol_by_name(left_name) else {
             continue;
         };
         if left_used.contains(&left_symbol_index) {
             continue;
         }
-        let Some(right_symbol_index) = symbol_ref_by_name(right, right_name) else {
+        let Some(right_symbol_index) = right.symbol_by_name(right_name) else {
             continue;
         };
         if right_used.contains(&right_symbol_index) {

objdiff-core/src/obj/mod.rs

@@ -118,7 +118,7 @@ impl Section {
             Err(i) => self
                 .relocations
                 .get(i)
-                .take_if(|r| r.address < ins_ref.address + ins_ref.size as u64),
+                .filter(|r| r.address < ins_ref.address + ins_ref.size as u64),
         }
         .and_then(|relocation| {
             let symbol = obj.symbols.get(relocation.target_symbol)?;
@@ -308,6 +308,10 @@ impl Object {
         let offset = symbol.address.checked_sub(section.address)?;
         section.data.get(offset as usize..offset as usize + symbol.size as usize)
     }
+
+    pub fn symbol_by_name(&self, name: &str) -> Option<usize> {
+        self.symbols.iter().position(|symbol| symbol.section.is_some() && symbol.name == name)
+    }
 }
 
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]

objdiff-core/src/obj/read.rs

@@ -121,6 +121,15 @@ fn map_symbols(
     Ok((symbols, symbol_indices))
 }
 
+/// When inferring a symbol's size, we ignore symbols that start with specific prefixes. They are
+/// usually emitted as branch targets and do not represent the start of a function or object.
+fn is_local_label(symbol: &Symbol) -> bool {
+    const LABEL_PREFIXES: &[&str] = &[".L", "LAB_"];
+    symbol.size == 0
+        && symbol.flags.contains(SymbolFlag::Local)
+        && LABEL_PREFIXES.iter().any(|p| symbol.name.starts_with(p))
+}
+
 fn infer_symbol_sizes(symbols: &mut [Symbol], sections: &[Section]) {
     // Create a sorted list of symbol indices by section
     let mut symbols_with_section = Vec::<usize>::with_capacity(symbols.len());
@@ -167,27 +176,28 @@ fn infer_symbol_sizes(symbols: &mut [Symbol], sections: &[Section]) {
         if last_end.0 == section_idx && last_end.1 > symbol.address {
             continue;
         }
-        let next_symbol = match symbol.kind {
-            // For function/object symbols, find the next function/object symbol (in other words:
-            // skip over labels)
-            SymbolKind::Function | SymbolKind::Object => loop {
-                if iter_idx >= symbols_with_section.len() {
-                    break None;
+        let next_symbol = loop {
+            if iter_idx >= symbols_with_section.len() {
+                break None;
+            }
+            let next_symbol = &symbols[symbols_with_section[iter_idx]];
+            if next_symbol.section != Some(section_idx) {
+                break None;
+            }
+            if match symbol.kind {
+                SymbolKind::Function | SymbolKind::Object => {
+                    // For function/object symbols, find the next function/object
+                    matches!(next_symbol.kind, SymbolKind::Function | SymbolKind::Object)
                 }
-                let next_symbol = &symbols[symbols_with_section[iter_idx]];
-                if next_symbol.section != Some(section_idx) {
-                    break None;
+                SymbolKind::Unknown | SymbolKind::Section => {
+                    // For labels (or anything else), stop at any symbol
+                    true
                 }
-                if let SymbolKind::Function | SymbolKind::Object = next_symbol.kind {
-                    break Some(next_symbol);
-                }
-                iter_idx += 1;
-            },
-            // For labels (or anything else), simply use the next symbol's address
-            SymbolKind::Unknown | SymbolKind::Section => symbols_with_section
-                .get(iter_idx)
-                .map(|&i| &symbols[i])
-                .take_if(|s| s.section == Some(section_idx)),
+            } && !is_local_label(next_symbol)
+            {
+                break Some(next_symbol);
+            }
+            iter_idx += 1;
         };
         let next_address = next_symbol.map(|s| s.address).unwrap_or_else(|| {
             let section = &sections[section_idx];
@@ -341,7 +351,7 @@ fn map_section_relocations(
                 let idx = if let Some(section_symbol) = obj_file
                     .symbol_by_index(idx)
                     .ok()
-                    .take_if(|s| s.kind() == object::SymbolKind::Section)
+                    .filter(|s| s.kind() == object::SymbolKind::Section)
                 {
                     let section_index =
                         section_symbol.section_index().context("Section symbol without section")?;

objdiff-core/tests/arch_x86.rs

@@ -68,3 +68,12 @@ fn read_x86_jumptable() {
     let output = common::display_diff(&obj, &diff, symbol_idx, &diff_config);
     insta::assert_snapshot!(output);
 }
+
+// Inferred size of functions should ignore symbols with specific prefixes
+#[test]
+#[cfg(feature = "x86")]
+fn read_x86_local_labels() {
+    let diff_config = diff::DiffObjConfig::default();
+    let obj = obj::read::parse(include_object!("data/x86/local_labels.obj"), &diff_config).unwrap();
+    insta::assert_debug_snapshot!(obj);
+}

objdiff-core/tests/snapshots/arch_x86__read_x86_local_labels.snap

@@ -0,0 +1,163 @@
+---
+source: objdiff-core/tests/arch_x86.rs
+expression: obj
+---
+Object {
+    arch: ArchX86 {
+        arch: X86,
+        endianness: Little,
+    },
+    endianness: Little,
+    symbols: [
+        Symbol {
+            name: "42b830_convertToUppercaseShiftJIS.obj",
+            demangled_name: None,
+            address: 0,
+            size: 0,
+            kind: Unknown,
+            section: None,
+            flags: FlagSet(Local),
+            align: None,
+            virtual_address: None,
+        },
+        Symbol {
+            name: "[.text]",
+            demangled_name: None,
+            address: 0,
+            size: 0,
+            kind: Section,
+            section: Some(
+                0,
+            ),
+            flags: FlagSet(Local),
+            align: None,
+            virtual_address: None,
+        },
+        Symbol {
+            name: "LAB_0042b850",
+            demangled_name: None,
+            address: 32,
+            size: 0,
+            kind: Object,
+            section: Some(
+                0,
+            ),
+            flags: FlagSet(Local),
+            align: None,
+            virtual_address: None,
+        },
+        Symbol {
+            name: "LAB_0042b883",
+            demangled_name: None,
+            address: 83,
+            size: 0,
+            kind: Object,
+            section: Some(
+                0,
+            ),
+            flags: FlagSet(Local),
+            align: None,
+            virtual_address: None,
+        },
+        Symbol {
+            name: "LAB_0042b87c",
+            demangled_name: None,
+            address: 76,
+            size: 0,
+            kind: Object,
+            section: Some(
+                0,
+            ),
+            flags: FlagSet(Local),
+            align: None,
+            virtual_address: None,
+        },
+        Symbol {
+            name: "LAB_0042b884",
+            demangled_name: None,
+            address: 84,
+            size: 0,
+            kind: Object,
+            section: Some(
+                0,
+            ),
+            flags: FlagSet(Local),
+            align: None,
+            virtual_address: None,
+        },
+        Symbol {
+            name: "LAB_0042b889",
+            demangled_name: None,
+            address: 89,
+            size: 0,
+            kind: Object,
+            section: Some(
+                0,
+            ),
+            flags: FlagSet(Local),
+            align: None,
+            virtual_address: None,
+        },
+        Symbol {
+            name: "LAB_0042b845",
+            demangled_name: None,
+            address: 21,
+            size: 0,
+            kind: Object,
+            section: Some(
+                0,
+            ),
+            flags: FlagSet(Local),
+            align: None,
+            virtual_address: None,
+        },
+        Symbol {
+            name: "LAB_0042b869",
+            demangled_name: None,
+            address: 57,
+            size: 0,
+            kind: Object,
+            section: Some(
+                0,
+            ),
+            flags: FlagSet(Local),
+            align: None,
+            virtual_address: None,
+        },
+        Symbol {
+            name: "ConvertToUppercaseShiftJIS",
+            demangled_name: None,
+            address: 0,
+            size: 92,
+            kind: Function,
+            section: Some(
+                0,
+            ),
+            flags: FlagSet(Global | SizeInferred),
+            align: None,
+            virtual_address: None,
+        },
+    ],
+    sections: [
+        Section {
+            id: ".text-0",
+            name: ".text",
+            address: 0,
+            size: 92,
+            kind: Code,
+            data: SectionData(
+                92,
+            ),
+            flags: FlagSet(),
+            align: Some(
+                16,
+            ),
+            relocations: [],
+            line_info: {},
+            virtual_address: None,
+        },
+    ],
+    split_meta: None,
+    path: None,
+    timestamp: None,
+}

objdiff-gui/src/views/diff.rs

@@ -49,7 +49,9 @@ impl<'a> DiffColumnContext<'a> {
         let selected_symbol = match view {
             View::SymbolDiff => None,
             View::FunctionDiff | View::ExtabDiff => match (obj, selected_symbol) {
-                (Some(obj), Some(s)) => find_symbol(&obj.0, s).map(SelectedSymbol::Symbol),
+                (Some(obj), Some(s)) => {
+                    obj.0.symbol_by_name(&s.symbol_name).map(SelectedSymbol::Symbol)
+                }
                 _ => None,
             },
             View::DataDiff => match (obj, selected_symbol) {
@@ -779,10 +781,6 @@ fn missing_obj_ui(ui: &mut Ui, appearance: &Appearance) {
     });
 }
 
-fn find_symbol(obj: &Object, selected_symbol: &SymbolRefByName) -> Option<usize> {
-    obj.symbols.iter().position(|symbol| symbol.name == selected_symbol.symbol_name)
-}
-
 fn find_section(obj: &Object, section_name: &str) -> Option<usize> {
     obj.sections.iter().position(|section| section.name == section_name)
 }

objdiff-wasm/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "objdiff-wasm",
-  "version": "3.0.0-beta.7",
+  "version": "3.0.0-beta.8",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "objdiff-wasm",
-      "version": "3.0.0-beta.7",
+      "version": "3.0.0-beta.8",
       "license": "MIT OR Apache-2.0",
       "devDependencies": {
         "@biomejs/biome": "^1.9.3",

objdiff-wasm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "objdiff-wasm",
-  "version": "3.0.0-beta.7",
+  "version": "3.0.0-beta.8",
   "description": "A local diffing tool for decompilation projects.",
   "author": {
     "name": "Luke Street",