objdiff-wasm 2.0.0 → 3.0.0-alpha.2

package/dist/config-schema.json

@@ -0,0 +1,264 @@
+{
+  "properties": [
+    {
+      "id": "functionRelocDiffs",
+      "type": "choice",
+      "default": "name_address",
+      "name": "Function relocation diffs",
+      "description": "How relocation targets will be diffed in the function view.",
+      "items": [
+        {
+          "value": "none",
+          "name": "None"
+        },
+        {
+          "value": "name_address",
+          "name": "Name or address"
+        },
+        {
+          "value": "data_value",
+          "name": "Data value"
+        },
+        {
+          "value": "all",
+          "name": "Name or address, data value"
+        }
+      ]
+    },
+    {
+      "id": "spaceBetweenArgs",
+      "type": "boolean",
+      "default": true,
+      "name": "Space between args",
+      "description": "Adds a space between arguments in the diff output."
+    },
+    {
+      "id": "combineDataSections",
+      "type": "boolean",
+      "default": false,
+      "name": "Combine data sections",
+      "description": "Combines data sections with equal names."
+    },
+    {
+      "id": "combineTextSections",
+      "type": "boolean",
+      "default": false,
+      "name": "Combine text sections",
+      "description": "Combines all text sections into one."
+    },
+    {
+      "id": "arm.archVersion",
+      "type": "choice",
+      "default": "auto",
+      "name": "Architecture version",
+      "description": "ARM architecture version to use for disassembly.",
+      "items": [
+        {
+          "value": "auto",
+          "name": "Auto"
+        },
+        {
+          "value": "v4t",
+          "name": "ARMv4T (GBA)"
+        },
+        {
+          "value": "v5te",
+          "name": "ARMv5TE (DS)"
+        },
+        {
+          "value": "v6k",
+          "name": "ARMv6K (3DS)"
+        }
+      ]
+    },
+    {
+      "id": "arm.unifiedSyntax",
+      "type": "boolean",
+      "default": false,
+      "name": "Unified syntax",
+      "description": "Disassemble as unified assembly language (UAL)."
+    },
+    {
+      "id": "arm.avRegisters",
+      "type": "boolean",
+      "default": false,
+      "name": "Use A/V registers",
+      "description": "Display R0-R3 as A1-A4 and R4-R11 as V1-V8."
+    },
+    {
+      "id": "arm.r9Usage",
+      "type": "choice",
+      "default": "generalPurpose",
+      "name": "Display R9 as",
+      "items": [
+        {
+          "value": "generalPurpose",
+          "name": "R9 or V6",
+          "description": "Use R9 as a general-purpose register."
+        },
+        {
+          "value": "sb",
+          "name": "SB (static base)",
+          "description": "Used for position-independent data (PID)."
+        },
+        {
+          "value": "tr",
+          "name": "TR (TLS register)",
+          "description": "Used for thread-local storage."
+        }
+      ]
+    },
+    {
+      "id": "arm.slUsage",
+      "type": "boolean",
+      "default": false,
+      "name": "Display R10 as SL",
+      "description": "Used for explicit stack limits."
+    },
+    {
+      "id": "arm.fpUsage",
+      "type": "boolean",
+      "default": false,
+      "name": "Display R11 as FP",
+      "description": "Used for frame pointers."
+    },
+    {
+      "id": "arm.ipUsage",
+      "type": "boolean",
+      "default": false,
+      "name": "Display R12 as IP",
+      "description": "Used for interworking and long branches."
+    },
+    {
+      "id": "mips.abi",
+      "type": "choice",
+      "default": "auto",
+      "name": "ABI",
+      "description": "MIPS ABI to use for disassembly.",
+      "items": [
+        {
+          "value": "auto",
+          "name": "Auto"
+        },
+        {
+          "value": "o32",
+          "name": "O32"
+        },
+        {
+          "value": "n32",
+          "name": "N32"
+        },
+        {
+          "value": "n64",
+          "name": "N64"
+        }
+      ]
+    },
+    {
+      "id": "mips.instrCategory",
+      "type": "choice",
+      "default": "auto",
+      "name": "Instruction category",
+      "description": "MIPS instruction category to use for disassembly.",
+      "items": [
+        {
+          "value": "auto",
+          "name": "Auto"
+        },
+        {
+          "value": "cpu",
+          "name": "CPU"
+        },
+        {
+          "value": "rsp",
+          "name": "RSP (N64)"
+        },
+        {
+          "value": "r3000gte",
+          "name": "R3000 GTE (PS1)"
+        },
+        {
+          "value": "r4000allegrex",
+          "name": "R4000 ALLEGREX (PSP)"
+        },
+        {
+          "value": "r5900",
+          "name": "R5900 EE (PS2)"
+        }
+      ]
+    },
+    {
+      "id": "mips.registerPrefix",
+      "type": "boolean",
+      "default": false,
+      "name": "Register '$' prefix",
+      "description": "Display MIPS register names with a '$' prefix."
+    },
+    {
+      "id": "x86.formatter",
+      "type": "choice",
+      "default": "intel",
+      "name": "Format",
+      "description": "x86 disassembly syntax.",
+      "items": [
+        {
+          "value": "intel",
+          "name": "Intel"
+        },
+        {
+          "value": "gas",
+          "name": "AT&T"
+        },
+        {
+          "value": "nasm",
+          "name": "NASM"
+        },
+        {
+          "value": "masm",
+          "name": "MASM"
+        }
+      ]
+    }
+  ],
+  "groups": [
+    {
+      "id": "general",
+      "name": "General",
+      "properties": [
+        "functionRelocDiffs",
+        "spaceBetweenArgs",
+        "combineDataSections",
+        "combineTextSections"
+      ]
+    },
+    {
+      "id": "arm",
+      "name": "ARM",
+      "properties": [
+        "arm.archVersion",
+        "arm.unifiedSyntax",
+        "arm.avRegisters",
+        "arm.r9Usage",
+        "arm.slUsage",
+        "arm.fpUsage",
+        "arm.ipUsage"
+      ]
+    },
+    {
+      "id": "mips",
+      "name": "MIPS",
+      "properties": [
+        "mips.abi",
+        "mips.instrCategory",
+        "mips.registerPrefix"
+      ]
+    },
+    {
+      "id": "x86",
+      "name": "x86",
+      "properties": [
+        "x86.formatter"
+      ]
+    }
+  ]
+}

package/dist/interfaces/objdiff-core-diff.d.ts

@@ -0,0 +1,33 @@
+/** @module Interface objdiff:core/diff **/
+export function runDiff(left: Object | undefined, right: Object | undefined, config: DiffConfig): DiffResult;
+export interface MappingConfig {
+  mappings: Array<[string, string]>,
+  selectingLeft?: string,
+  selectingRight?: string,
+}
+export interface DiffResult {
+  left?: ObjectDiff,
+  right?: ObjectDiff,
+}
+
+export class DiffConfig {
+  constructor()
+  setProperty(id: string, value: string): void;
+  getProperty(id: string): string;
+}
+
+export class Object {
+  /**
+   * This type does not have a public constructor.
+   */
+  private constructor();
+  static parse(data: Uint8Array, config: DiffConfig): Object;
+}
+
+export class ObjectDiff {
+  /**
+   * This type does not have a public constructor.
+   */
+  private constructor();
+  findSymbol(name: string, sectionName: string | undefined): number | undefined;
+}

package/dist/interfaces/objdiff-core-display.d.ts

@@ -0,0 +1,224 @@
+/** @module Interface objdiff:core/display **/
+export function displaySections(diff: ObjectDiff, filter: SymbolFilter, config: DisplayConfig): Array<SectionDisplay>;
+export function displaySymbol(diff: ObjectDiff, symbol: SectionDisplaySymbol): SymbolDisplay;
+export function displayInstructionRow(diff: ObjectDiff, symbol: SectionDisplaySymbol, rowIndex: number, config: DiffConfig): InstructionDiffRow;
+export function symbolContext(diff: ObjectDiff, symbol: SectionDisplaySymbol): Array<ContextItem>;
+export function symbolHover(diff: ObjectDiff, symbol: SectionDisplaySymbol): Array<HoverItem>;
+export function instructionContext(diff: ObjectDiff, symbol: SectionDisplaySymbol, rowIndex: number, config: DiffConfig): Array<ContextItem>;
+export function instructionHover(diff: ObjectDiff, symbol: SectionDisplaySymbol, rowIndex: number, config: DiffConfig): Array<HoverItem>;
+export type Object = import('./objdiff-core-diff.js').Object;
+export type ObjectDiff = import('./objdiff-core-diff.js').ObjectDiff;
+export type DiffConfig = import('./objdiff-core-diff.js').DiffConfig;
+export type SymbolRef = number;
+export interface DisplayConfig {
+  showHiddenSymbols: boolean,
+  showMappedSymbols: boolean,
+  reverseFnOrder: boolean,
+}
+export interface SymbolFilter {
+  regex?: string,
+  mapping?: SymbolRef,
+}
+export interface SectionDisplaySymbol {
+  symbol: SymbolRef,
+  isMappingSymbol: boolean,
+}
+export interface SectionDisplay {
+  id: string,
+  name: string,
+  size: bigint,
+  matchPercent?: number,
+  symbols: Array<SectionDisplaySymbol>,
+}
+/**
+ * # Variants
+ * 
+ * ## `"unknown"`
+ * 
+ * ## `"function"`
+ * 
+ * ## `"object"`
+ * 
+ * ## `"section"`
+ */
+export type SymbolKind = 'unknown' | 'function' | 'object' | 'section';
+export interface SymbolFlags {
+  global?: boolean,
+  local?: boolean,
+  weak?: boolean,
+  common?: boolean,
+  hidden?: boolean,
+  hasExtra?: boolean,
+  sizeInferred?: boolean,
+}
+export interface SymbolDisplay {
+  name: string,
+  demangledName?: string,
+  address: bigint,
+  size: bigint,
+  kind: SymbolKind,
+  section?: number,
+  flags: SymbolFlags,
+  align?: number,
+  virtualAddress?: bigint,
+  targetSymbol?: SymbolRef,
+  matchPercent?: number,
+  diffScore?: [bigint, bigint],
+  rowCount: number,
+}
+/**
+ * # Variants
+ * 
+ * ## `"normal"`
+ * 
+ * ## `"extab"`
+ */
+export type SymbolNavigationKind = 'normal' | 'extab';
+export interface ContextItemCopy {
+  value: string,
+  label?: string,
+}
+export interface ContextItemNavigate {
+  label: string,
+  symbol: SymbolRef,
+  kind: SymbolNavigationKind,
+}
+export type ContextItem = ContextItemCopy | ContextItemNavigate | ContextItemSeparator;
+export interface ContextItemCopy {
+  tag: 'copy',
+  val: ContextItemCopy,
+}
+export interface ContextItemNavigate {
+  tag: 'navigate',
+  val: ContextItemNavigate,
+}
+export interface ContextItemSeparator {
+  tag: 'separator',
+}
+/**
+ * # Variants
+ * 
+ * ## `"normal"`
+ * 
+ * ## `"emphasized"`
+ * 
+ * ## `"special"`
+ */
+export type HoverItemColor = 'normal' | 'emphasized' | 'special';
+export interface HoverItemText {
+  label: string,
+  value: string,
+  color: HoverItemColor,
+}
+export type HoverItem = HoverItemText | HoverItemSeparator;
+export interface HoverItemText {
+  tag: 'text',
+  val: HoverItemText,
+}
+export interface HoverItemSeparator {
+  tag: 'separator',
+}
+export interface DiffTextOpcode {
+  mnemonic: string,
+  opcode: number,
+}
+export interface DiffTextSymbol {
+  name: string,
+  demangledName?: string,
+}
+export type DiffText = DiffTextBasic | DiffTextLine | DiffTextAddress | DiffTextOpcode | DiffTextSigned | DiffTextUnsigned | DiffTextOpaque | DiffTextBranchDest | DiffTextSymbol | DiffTextAddend | DiffTextSpacing | DiffTextEol;
+export interface DiffTextBasic {
+  tag: 'basic',
+  val: string,
+}
+export interface DiffTextLine {
+  tag: 'line',
+  val: number,
+}
+export interface DiffTextAddress {
+  tag: 'address',
+  val: bigint,
+}
+export interface DiffTextOpcode {
+  tag: 'opcode',
+  val: DiffTextOpcode,
+}
+export interface DiffTextSigned {
+  tag: 'signed',
+  val: bigint,
+}
+export interface DiffTextUnsigned {
+  tag: 'unsigned',
+  val: bigint,
+}
+export interface DiffTextOpaque {
+  tag: 'opaque',
+  val: string,
+}
+export interface DiffTextBranchDest {
+  tag: 'branch-dest',
+  val: bigint,
+}
+export interface DiffTextSymbol {
+  tag: 'symbol',
+  val: DiffTextSymbol,
+}
+export interface DiffTextAddend {
+  tag: 'addend',
+  val: bigint,
+}
+export interface DiffTextSpacing {
+  tag: 'spacing',
+  val: number,
+}
+export interface DiffTextEol {
+  tag: 'eol',
+}
+export type DiffTextColor = DiffTextColorNormal | DiffTextColorDim | DiffTextColorBright | DiffTextColorReplace | DiffTextColorDelete | DiffTextColorInsert | DiffTextColorRotating;
+export interface DiffTextColorNormal {
+  tag: 'normal',
+}
+export interface DiffTextColorDim {
+  tag: 'dim',
+}
+export interface DiffTextColorBright {
+  tag: 'bright',
+}
+export interface DiffTextColorReplace {
+  tag: 'replace',
+}
+export interface DiffTextColorDelete {
+  tag: 'delete',
+}
+export interface DiffTextColorInsert {
+  tag: 'insert',
+}
+export interface DiffTextColorRotating {
+  tag: 'rotating',
+  val: number,
+}
+export interface DiffTextSegment {
+  text: DiffText,
+  color: DiffTextColor,
+  padTo: number,
+}
+/**
+ * # Variants
+ * 
+ * ## `"none"`
+ * 
+ * ## `"op-mismatch"`
+ * 
+ * ## `"arg-mismatch"`
+ * 
+ * ## `"replace"`
+ * 
+ * ## `"insert"`
+ * 
+ * ## `"delete"`
+ */
+export type InstructionDiffKind = 'none' | 'op-mismatch' | 'arg-mismatch' | 'replace' | 'insert' | 'delete';
+export interface InstructionDiffRow {
+  segments: Array<DiffTextSegment>,
+  diffKind: InstructionDiffKind,
+}

package/dist/interfaces/wasi-logging-logging.d.ts

@@ -0,0 +1,18 @@
+/** @module Interface wasi:logging/logging@0.1.0-draft **/
+export function log(level: Level, context: string, message: string): void;
+/**
+ * # Variants
+ * 
+ * ## `"trace"`
+ * 
+ * ## `"debug"`
+ * 
+ * ## `"info"`
+ * 
+ * ## `"warn"`
+ * 
+ * ## `"error"`
+ * 
+ * ## `"critical"`
+ */
+export type Level = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'critical';

package/dist/objdiff.d.ts

@@ -0,0 +1,7 @@
+// world root:component/root
+export type Level = import('./interfaces/wasi-logging-logging.js').Level;
+export type * as WasiLoggingLogging010Draft from './interfaces/wasi-logging-logging.js'; // import wasi:logging/logging@0.1.0-draft
+export * as diff from './interfaces/objdiff-core-diff.js'; // export objdiff:core/diff
+export * as display from './interfaces/objdiff-core-display.js'; // export objdiff:core/display
+export function init(level: Level): void;
+export function version(): string;