Files
reverse-engineering-anything/src/process/ProviderOutcome.ts
T
morluto c296c91770 fix(apktool): report the decoder JVM's heap exhaustion as memory, not a target refusal (#10634)
* fix(pcap): report a refused tool launch as an unavailable tool

When a capture read's tool launch was refused with EPERM, pcap reported it
as unreadable tool output (AnalysisProtocolError) instead of an unavailable
tool. Pcap also never told "not executable" apart from "missing".

Add classifyLaunchFailure in src/process as the one owner of which spawn
errnos mean missing (ENOENT, ENOTDIR) and which mean present but not
executable (EACCES, EPERM, ENOEXEC, EISDIR). Pcap, apktool and gdb used three
different errno lists; all three now use it.

* refactor(process): classify owned command outcomes through one owner

Add ProviderOutcome, read once from the supervisor's facts, and classifyProviderOutcome, the one mapping from an outcome to a typed error. Migrate pcap and the shared artifact producer command failure (TShark, sigrok). Add the rea/provider-failure-classifier lint rule with a shrink-only baseline of per-site (cause: unknown) => AnalysisError functions.

* refactor(process): classify Java and adb launch refusals with the shared owner (#10598)

The Ghidra and JADX Java probes and adb's version probe now take
missing-versus-not-executable from classifyLaunchFailure instead of their
own errno checks. ELOOP and ENAMETOOLONG join the owner's missing set, so
adb keeps its existing classification and both Java probes now treat a
non-directory path component as a missing runtime.

* fix(pcap): preserve command launch attribution

* test(pcap): expect an unknown failing stage when a limited capture tool exits unsuccessfully

* refactor(process): classify owned command outcomes through one owner

Add ProviderOutcome, read once from the supervisor's facts, and classifyProviderOutcome, the one mapping from an outcome to a typed error. Migrate pcap and the shared artifact producer command failure (TShark, sigrok). Add the rea/provider-failure-classifier lint rule with a shrink-only baseline of per-site (cause: unknown) => AnalysisError functions.

* test(lint): cover baselined files in the provider-failure classifier rule

* fix(apktool): report the decoder JVM's heap exhaustion as memory, not a target refusal

The supervisor now watches for a managed runtime's out-of-memory report while output streams (JVM java.lang.OutOfMemoryError, V8 'JavaScript heap out of memory'), so a retention budget cannot hide it. ProviderOutcome gains a runtime-exhausted kind and classifyProviderOutcome maps it once. Apktool decode opts in and moves to the shared classifier; Ghidra's single-purpose output token becomes the JVM runtime option and its area matching reuses the shared table.

* fix(process): keep the runtime's out-of-memory report on the memory error it supports

* fix(pcap): attribute a limited capture's exit through the prlimit wrapper

* fix(process): keep a shortened out-of-memory line marked as shortened

* fix(process): identify the refused executable for every launcher shape

Name the executable on errnos Node throws synchronously from spawn
(ENOEXEC, ENOTDIR, ...) and read the Windows native launcher's
executable-launch constraint, so pcap attributes those refusals to the
selected tool or limiter instead of an unknown stage.

* test(pcap): prove synchronous launch naming with ENOTDIR on every POSIX host

* fix(apktool): advise the JVM limit that governs the reported memory area

* fix(ghidra): read the supervisor's parsed OOM area instead of reparsing lines

* fix(sqlite,capture): read V8 heap exhaustion from streamed output, not retained stderr (#10724)

The SQLite worker and the Node capture decoders now declare runtime: "v8", so the supervisor observes V8's heap report as output streams. Both classifiers read the runtime-exhausted outcome instead of matching retained stderr, so a report beyond the retention budget, or one whose process then overflowed its output budget, is still reported as memory exhaustion.

* refactor(evm): classify EVMole worker outcomes through the shared provider classifier (#10716)

* refactor(evm): classify EVMole worker outcomes through the shared provider classifier

The EVMole worker's cancellation, deadline, output budget and CPU/file-size signals now go through classifyProviderOutcome; only the prlimit launch refusal and the reserved EFBIG exit remain in its dialect. The worker is opted into V8 exhaustion scanning so a heap report names its fixed 256 MiB heap. providerOutcomeOf now reads a launch refusal only from a spawn errno, so a private-storage or carrier read errno is no longer reported as a limiter launch failure.

* fix(evm): keep a stream failure's exit status and update Linux worker expectations

* refactor(process): read launch refusals through the launcher identity owner

* refactor(wasm): classify WABT command outcomes through the shared provider classifier (#10727)

* refactor(wasm): classify WABT command outcomes through the shared provider classifier

WABT's cancellation, command deadline, output budget, and inherited-limit signals now go through classifyProviderOutcome; its dialect keeps only the configuration-probe and launch-refusal unavailability and the unclassified-exit output error. A tool ended by SIGXCPU/SIGXFSZ or the memory limit is now a resource constraint instead of an output error, and a refused launch in the producer phase is reported as unavailable. The shared timeout context gains the analysis setting that selected the deadline, and the output-limit context may name its exceeded budget.

* fix(wasm): keep setup guidance when a WABT version probe's output cannot be collected

* refactor(process): build classified cancellations with cancelledBy and the carried caller reason

* chore(lint): count runOwned's close-failure mapper from main in the classifier baseline

* fix(process): carry the runtime's exhaustion report on every memory error that claims it

SQLite and historical-capture memory errors recognised a streamed V8 heap report but dropped it, so a report outside retained output reached callers without its source line or omission flags. One projection, runtimeExhaustionReport, now owns that shape for the shared classifier and both consumers. Also lowers the EVMole and WABT cancellation-constructor baselines.

* fix(process): keep the provider's recovery for a native-thread exhaustion report

The shared classifier replaced the provider-supplied recovery with generic capacity advice whenever the JVM reported it could not create a native thread, dropping Apktool's launcher guidance and flipping retryable to true. The provider's recovery now wins; the capacity advice remains the fallback for providers that supply none.
2026-11-15 15:11:31 +08:00

154 lines
5.6 KiB
TypeScript

import { launcherRefusalOf, type LauncherRefusal } from "./launchFailure.js";
import { OwnedCommandFailure } from "./OwnedCommand.js";
import type { ProviderProcessSnapshot } from "./ProviderProcess.js";
import type { RuntimeExhaustion } from "./RuntimeExhaustion.js";
/** Output the supervisor retained for one outcome. */
export interface ProviderOutcomeOutput {
readonly snapshot: ProviderProcessSnapshot;
/**
* True when the retained output omits bytes: the retention budget was
* exceeded or a provider stream was destroyed before it drained.
*/
readonly truncated: boolean;
}
interface ProviderOutcomeFacts {
/** The value the supervisor or launcher threw; kept as the error cause. */
readonly cause: unknown;
readonly message: string;
/** Absent when the failure happened before any process output existed. */
readonly output: ProviderOutcomeOutput | undefined;
}
/**
* What physically happened to one owned provider command, read once from the
* supervisor's facts. Classification into a typed error belongs to
* `classifyProviderOutcome`.
*/
export type ProviderOutcome =
/** The operating system refused to start the selected executable. */
| (ProviderOutcomeFacts & {
readonly kind: "launch-refused";
readonly refusal: LauncherRefusal;
})
/** The caller cancelled; `reason` is the caller's opaque abort reason. */
| (ProviderOutcomeFacts & {
readonly kind: "cancelled";
readonly reason: unknown;
})
/** The owner's deadline elapsed. */
| (ProviderOutcomeFacts & { readonly kind: "timeout" })
/** Output exceeded the owner's complete-output budget. */
| (ProviderOutcomeFacts & { readonly kind: "output-limit" })
/** The process tree reached its enforced memory limit. */
| (ProviderOutcomeFacts & { readonly kind: "memory-limit" })
/**
* The process ended after its runtime reported running out of memory. The
* report was observed while output streamed, beyond any retention budget.
*/
| (ProviderOutcomeFacts & {
readonly kind: "runtime-exhausted";
readonly exhaustion: RuntimeExhaustion;
readonly exitCode: number | null;
readonly signal: NodeJS.Signals | null;
})
/** The process ended on an inherited CPU-time or file-size limit signal. */
| (ProviderOutcomeFacts & {
readonly kind: "resource-signal";
readonly signal: "SIGXCPU" | "SIGXFSZ";
})
/**
* The process ended with this status. `stopRequested` is true when the
* owner had begun stopping it, so a signal may be the owner's.
*/
| (ProviderOutcomeFacts & {
readonly kind: "exited";
readonly exitCode: number | null;
readonly signal: NodeJS.Signals | null;
readonly stopRequested: boolean;
})
/** Collecting the command's streams failed, or no process facts exist. */
| (ProviderOutcomeFacts & { readonly kind: "protocol" });
const outputOf = (
snapshot: ProviderProcessSnapshot | null,
): ProviderOutcomeOutput | undefined =>
snapshot === null
? undefined
: {
snapshot,
truncated:
snapshot.diagnosticTruncated === true ||
snapshot.outputIncomplete === true,
};
const ownedCommandOutcome = (failure: OwnedCommandFailure): ProviderOutcome => {
const facts = {
cause: failure,
message: failure.message,
output: outputOf(failure.snapshot),
};
if (failure.reason === "cancelled")
return {
...facts,
kind: "cancelled",
reason:
failure.cancellation === undefined
? failure
: failure.cancellation.reason,
};
// An allocation refused by the enforced limit can surface as a hang, an
// overflow or an exit; the limit is the fact that explains each of them.
if (failure.snapshot?.memoryLimitReached === true)
return { ...facts, kind: "memory-limit" };
const snapshot = failure.snapshot;
// The runtime's own report explains an exit or the stack trace that
// overflowed the output budget; it does not explain the owner's deadline.
if (
snapshot?.runtimeExhaustion !== undefined &&
!failure.collectionFailure &&
(failure.reason === "process" || failure.reason === "output-limit")
)
return {
...facts,
kind: "runtime-exhausted",
exhaustion: snapshot.runtimeExhaustion,
exitCode: snapshot.exitCode ?? null,
signal: snapshot.signal ?? null,
};
if (failure.reason !== "process") return { ...facts, kind: failure.reason };
if (failure.collectionFailure || snapshot === null)
return { ...facts, kind: "protocol" };
if (snapshot.signal === "SIGXCPU" || snapshot.signal === "SIGXFSZ")
return { ...facts, kind: "resource-signal", signal: snapshot.signal };
return {
...facts,
kind: "exited",
exitCode: snapshot.exitCode ?? null,
signal: snapshot.signal ?? null,
stopRequested: snapshot.stopRequested === true,
};
};
/**
* Read the outcome of an owned command from what `runOwnedCommand` threw.
* Undefined when the value is neither a supervised command failure nor a
* launch refusal.
*/
export function providerOutcomeOf(cause: OwnedCommandFailure): ProviderOutcome;
export function providerOutcomeOf(cause: unknown): ProviderOutcome | undefined;
export function providerOutcomeOf(cause: unknown): ProviderOutcome | undefined {
if (cause instanceof OwnedCommandFailure) return ownedCommandOutcome(cause);
// Only a launcher's errno is a launch refusal; one from reading a file is not.
const refusal = launcherRefusalOf(cause);
if (refusal === undefined || !(cause instanceof Error)) return undefined;
return {
kind: "launch-refused",
refusal,
cause,
message: cause.message,
output: undefined,
};
}