Make objdiff-core no_std + huge WASM rework

2025-12-10 22:17:51 +00:00 · 2025-02-07 00:10:49 -07:00
parent d938988d43
commit e8de35b78e
49 changed files with 1463 additions and 1046 deletions
--- a/objdiff-wasm/src/display.ts
+++ b/objdiff-wasm/src/display.ts
@@ -0,0 +1,107 @@
+import {ArgumentValue, InstructionDiff, RelocationTarget} from "../gen/diff_pb";
+
+export type DiffText =
+    DiffTextBasic
+    | DiffTextBasicColor
+    | DiffTextAddress
+    | DiffTextLine
+    | DiffTextOpcode
+    | DiffTextArgument
+    | DiffTextSymbol
+    | DiffTextBranchDest
+    | DiffTextSpacing;
+
+type DiffTextBase = {
+    diff_index?: number,
+};
+export type DiffTextBasic = DiffTextBase & {
+    type: 'basic',
+    text: string,
+};
+export type DiffTextBasicColor = DiffTextBase & {
+    type: 'basic_color',
+    text: string,
+    index: number,
+};
+export type DiffTextAddress = DiffTextBase & {
+    type: 'address',
+    address: bigint,
+};
+export type DiffTextLine = DiffTextBase & {
+    type: 'line',
+    line_number: number,
+};
+export type DiffTextOpcode = DiffTextBase & {
+    type: 'opcode',
+    mnemonic: string,
+    opcode: number,
+};
+export type DiffTextArgument = DiffTextBase & {
+    type: 'argument',
+    value: ArgumentValue,
+};
+export type DiffTextSymbol = DiffTextBase & {
+    type: 'symbol',
+    target: RelocationTarget,
+};
+export type DiffTextBranchDest = DiffTextBase & {
+    type: 'branch_dest',
+    address: bigint,
+};
+export type DiffTextSpacing = DiffTextBase & {
+    type: 'spacing',
+    count: number,
+};
+
+// Native JavaScript implementation of objdiff_core::diff::display::display_diff
+export function displayDiff(diff: InstructionDiff, baseAddr: bigint, cb: (text: DiffText) => void) {
+    const ins = diff.instruction;
+    if (!ins) {
+        return;
+    }
+    if (ins.line_number != null) {
+        cb({type: 'line', line_number: ins.line_number});
+    }
+    cb({type: 'address', address: ins.address - baseAddr});
+    if (diff.branch_from) {
+        cb({type: 'basic_color', text: ' ~> ', index: diff.branch_from.branch_index});
+    } else {
+        cb({type: 'spacing', count: 4});
+    }
+    cb({type: 'opcode', mnemonic: ins.mnemonic, opcode: ins.opcode});
+    let arg_diff_idx = 0; // non-PlainText argument index
+    for (let i = 0; i < ins.arguments.length; i++) {
+        if (i === 0) {
+            cb({type: 'spacing', count: 1});
+        }
+        const arg = ins.arguments[i].value;
+        let diff_index: number | undefined;
+        if (arg.oneofKind !== 'plain_text') {
+            diff_index = diff.arg_diff[arg_diff_idx]?.diff_index;
+            arg_diff_idx++;
+        }
+        switch (arg.oneofKind) {
+            case "plain_text":
+                cb({type: 'basic', text: arg.plain_text, diff_index});
+                break;
+            case "argument":
+                cb({type: 'argument', value: arg.argument, diff_index});
+                break;
+            case "relocation": {
+                const reloc = ins.relocation!;
+                cb({type: 'symbol', target: reloc.target!, diff_index});
+                break;
+            }
+            case "branch_dest":
+                if (arg.branch_dest < baseAddr) {
+                    cb({type: 'basic', text: '<unknown>', diff_index});
+                } else {
+                    cb({type: 'branch_dest', address: arg.branch_dest - baseAddr, diff_index});
+                }
+                break;
+        }
+    }
+    if (diff.branch_to) {
+        cb({type: 'basic_color', text: ' ~> ', index: diff.branch_to.branch_index});
+    }
+}
--- a/objdiff-wasm/src/main.ts
+++ b/objdiff-wasm/src/main.ts
@@ -1,20 +1,20 @@
-import {ArgumentValue, DiffResult, InstructionDiff, RelocationTarget} from "../gen/diff_pb";
+import {DiffResult} from "../gen/diff_pb";
 import type {
-    ArmArchVersion,
-    ArmR9Usage,
-    DiffObjConfig,
-    MipsAbi,
-    MipsInstrCategory,
-    X86Formatter
+    ConfigProperty,
+    MappingConfig,
+    SymbolMappings,
 } from '../pkg';
 import {AnyHandlerData, InMessage, OutMessage} from './worker';

 // Export wasm types
-export {ArmArchVersion, ArmR9Usage, MipsAbi, MipsInstrCategory, X86Formatter, DiffObjConfig};
+export {ConfigProperty, MappingConfig, SymbolMappings};

 // Export protobuf types
 export * from '../gen/diff_pb';

+// Export display types
+export * from './display';
+
 interface PromiseCallbacks<T> {
    start: number;
    resolve: (value: T | PromiseLike<T>) => void;
@@ -111,12 +111,18 @@ async function defer<T>(message: AnyHandlerData, worker?: Worker): Promise<T> {
    return promise;
 }

-export async function runDiff(left: Uint8Array | undefined, right: Uint8Array | undefined, diff_config?: DiffObjConfig): Promise<DiffResult> {
+export async function runDiff(
+    left: Uint8Array | null | undefined,
+    right: Uint8Array | null | undefined,
+    properties?: ConfigProperty[],
+    mappingConfig?: MappingConfig,
+): Promise<DiffResult> {
    const data = await defer<Uint8Array>({
        type: 'run_diff_proto',
        left,
        right,
-        diff_config
+        properties,
+        mappingConfig,
    });
    const parseStart = performance.now();
    const result = DiffResult.fromBinary(data, {readUnknownField: false});
@@ -124,109 +130,3 @@ export async function runDiff(left: Uint8Array | undefined, right: Uint8Array |
    console.debug(`Parsing message took ${end - parseStart}ms`);
    return result;
 }
-
-export type DiffText =
-    DiffTextBasic
-    | DiffTextBasicColor
-    | DiffTextAddress
-    | DiffTextLine
-    | DiffTextOpcode
-    | DiffTextArgument
-    | DiffTextSymbol
-    | DiffTextBranchDest
-    | DiffTextSpacing;
-
-type DiffTextBase = {
-    diff_index?: number,
-};
-export type DiffTextBasic = DiffTextBase & {
-    type: 'basic',
-    text: string,
-};
-export type DiffTextBasicColor = DiffTextBase & {
-    type: 'basic_color',
-    text: string,
-    index: number,
-};
-export type DiffTextAddress = DiffTextBase & {
-    type: 'address',
-    address: bigint,
-};
-export type DiffTextLine = DiffTextBase & {
-    type: 'line',
-    line_number: number,
-};
-export type DiffTextOpcode = DiffTextBase & {
-    type: 'opcode',
-    mnemonic: string,
-    opcode: number,
-};
-export type DiffTextArgument = DiffTextBase & {
-    type: 'argument',
-    value: ArgumentValue,
-};
-export type DiffTextSymbol = DiffTextBase & {
-    type: 'symbol',
-    target: RelocationTarget,
-};
-export type DiffTextBranchDest = DiffTextBase & {
-    type: 'branch_dest',
-    address: bigint,
-};
-export type DiffTextSpacing = DiffTextBase & {
-    type: 'spacing',
-    count: number,
-};
-
-// Native JavaScript implementation of objdiff_core::diff::display::display_diff
-export function displayDiff(diff: InstructionDiff, baseAddr: bigint, cb: (text: DiffText) => void) {
-    const ins = diff.instruction;
-    if (!ins) {
-        return;
-    }
-    if (ins.line_number != null) {
-        cb({type: 'line', line_number: ins.line_number});
-    }
-    cb({type: 'address', address: ins.address - baseAddr});
-    if (diff.branch_from) {
-        cb({type: 'basic_color', text: ' ~> ', index: diff.branch_from.branch_index});
-    } else {
-        cb({type: 'spacing', count: 4});
-    }
-    cb({type: 'opcode', mnemonic: ins.mnemonic, opcode: ins.opcode});
-    let arg_diff_idx = 0; // non-PlainText argument index
-    for (let i = 0; i < ins.arguments.length; i++) {
-        if (i === 0) {
-            cb({type: 'spacing', count: 1});
-        }
-        const arg = ins.arguments[i].value;
-        let diff_index: number | undefined;
-        if (arg.oneofKind !== 'plain_text') {
-            diff_index = diff.arg_diff[arg_diff_idx]?.diff_index;
-            arg_diff_idx++;
-        }
-        switch (arg.oneofKind) {
-            case "plain_text":
-                cb({type: 'basic', text: arg.plain_text, diff_index});
-                break;
-            case "argument":
-                cb({type: 'argument', value: arg.argument, diff_index});
-                break;
-            case "relocation": {
-                const reloc = ins.relocation!;
-                cb({type: 'symbol', target: reloc.target!, diff_index});
-                break;
-            }
-            case "branch_dest":
-                if (arg.branch_dest < baseAddr) {
-                    cb({type: 'basic', text: '<unknown>', diff_index});
-                } else {
-                    cb({type: 'branch_dest', address: arg.branch_dest - baseAddr, diff_index});
-                }
-                break;
-        }
-    }
-    if (diff.branch_to) {
-        cb({type: 'basic_color', text: ' ~> ', index: diff.branch_to.branch_index});
-    }
-}
--- a/objdiff-wasm/src/worker.ts
+++ b/objdiff-wasm/src/worker.ts
@@ -2,7 +2,6 @@ import wasmInit, * as exports from '../pkg';

 const handlers = {
    init: init,
-    // run_diff_json: run_diff_json,
    run_diff_proto: run_diff_proto,
 } as const;
 type ExtractData<T> = T extends (arg: infer U) => Promise<unknown> ? U : never;
@@ -29,24 +28,16 @@ async function initIfNeeded() {
    return wasmReady;
 }

-// async function run_diff_json({left, right, config}: {
-//     left: Uint8Array | undefined,
-//     right: Uint8Array | undefined,
-//     config?: exports.DiffObjConfig,
-// }): Promise<string> {
-//     config = config || exports.default_diff_obj_config();
-//     return exports.run_diff_json(left, right, cfg);
-// }
-
-async function run_diff_proto({left, right, diff_config, mapping_config}: {
-    left: Uint8Array | undefined,
-    right: Uint8Array | undefined,
-    diff_config?: exports.DiffObjConfig,
-    mapping_config?: exports.MappingConfig,
+async function run_diff_proto({left, right, properties, mappingConfig}: {
+    left: Uint8Array | null | undefined,
+    right: Uint8Array | null | undefined,
+    properties?: exports.ConfigProperty[],
+    mappingConfig?: exports.MappingConfig,
 }): Promise<Uint8Array> {
-    diff_config = diff_config || {};
-    mapping_config = mapping_config || {};
-    return exports.run_diff_proto(left, right, diff_config, mapping_config);
+    const diffConfig = exports.config_from_properties(properties || []);
+    const leftObj = left ? exports.parse_object(left, diffConfig) : null;
+    const rightObj = right ? exports.parse_object(right, diffConfig) : null;
+    return exports.run_diff(leftObj, rightObj, diffConfig, mappingConfig || {});
 }

 export type AnyHandlerData = HandlerData[keyof HandlerData];