B.29 outcome.*

8 min read

Every field the catalogue defines under outcome, in path order. Each entry gives the field's definition and, under Carried by, every event type that writes it.

B.29.1 outcome.address #

  • Type: uint
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

The user-space address that faulted when the kernel tried to copy from or to it. Meaningful only within the faulting process's address space, and only until that address space changes.

Carried by:

No event carries this field yet.

B.29.2 outcome.cleanup #

  • Type: str.enum
  • Values: succeeded · failed · declined
  • Set: closed
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

The outcome of the compensating action StrataFS took to undo part of a failed operation, such as removing an object it had just created. declined means StrataFS deliberately did not undo it, because the name no longer referred to the object it had created and removing it could have removed someone else's.

Both failed and declined leave an object behind in the stratum that nothing in the merged view accounts for.

Carried by:

No event carries this field yet.

B.29.3 outcome.data-lost #

  • Type: bool
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

Whether the outcome a record describes destroyed data, rather than only failing to do what was asked. Set this aside from ordinary failures: a data-losing outcome is not recovered by retrying.

Carried by:

No event carries this field yet.

B.29.4 outcome.deferred #

  • Type: bool
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

Whether a refusal was raised after the caller had already been told the operation succeeded. A deferred refusal has nobody left to receive an error, which is why it is recorded unconditionally rather than only for the arrangement errors.

Carried by:

B.29.5 outcome.detail #

  • Type: str
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

Free text about the outcome, for a person to read. Optional, and never parsed: anything a consumer would filter on belongs in outcome.reason or a field of its own. Never the output of a language's debug formatter.

Carried by:

B.29.6 outcome.errno #

  • Type: int.errno
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

The error the operation failed with, as a negative errno. Absent on success. Present where an event records an outcome that has a specific failure rather than only a boolean.

Carried by:

B.29.7 outcome.errno-cleanup #

  • Type: int.errno
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

The error a compensating action failed with, when an operation failed and its undo failed too. Read with outcome.errno, the error of the operation itself: the pair is how orphaned objects come to exist. Absent when the undo succeeded or was not attempted.

Carried by:

No event carries this field yet.

B.29.8 outcome.errno-masked #

  • Type: int.errno
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

The error an underlying step actually failed with, where StrataFS returned a different one to the caller. outcome.errno holds the error the caller saw; this field holds the one it replaced, which is usually the one that explains the failure.

Carried by:

No event carries this field yet.

B.29.9 outcome.fallback #

  • Type: bool
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

Whether the operation took a fallback path because the mechanism it prefers was unavailable. The operation still completed, by a slower or coarser route.

Carried by:

No event carries this field yet.

B.29.10 outcome.field #

  • Type: str
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

The name of the structure field an error was attributed to, such as the member of an argument structure that was out of range.

Carried by:

No event carries this field yet.

B.29.11 outcome.invariant-violated #

  • Type: bool
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

Whether an internal invariant was found broken and execution continued anyway. A record with this set describes a state the code assumes cannot happen, so treat whatever follows it on the same mount as suspect.

Carried by:

No event carries this field yet.

B.29.12 outcome.offset #

  • Type: uint
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

The byte offset within the input at which parsing failed. Read with outcome.field where the input is a structure.

Carried by:

No event carries this field yet.

B.29.13 outcome.reason #

  • Type: str.enum
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

Why the operation resolved the way it did. Each event declares its own values: a list, or a curated subset of a uapi/pkm/trace.h family, which carries codes that are never event reasons. A trace code is rendered with the family prefix stripped and case folded, so KACS_FSR_GRANT_DENY presents as grant-deny, and an investigation escalating from the event stream to a live trace sees the same decision described in the same terms.

Carried by:

B.29.14 outcome.result-raw #

  • Type: int
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

A raw result from an internal step that was neither zero nor a valid negative errno, recorded instead of being passed on. Deliberately not outcome.errno: a value outside the errno range returned from an open could reach the caller as a pointer to a file, so StrataFS converts it to EIO, and this field holds what it caught.

Carried by:

No event carries this field yet.

B.29.15 outcome.reverted #

  • Type: bool
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

Whether a credential change the kernel had prepared was silently undone, so that the call returned success having changed nothing. The caller is told it worked; this is the only record that it did not.

Carried by:

No event carries this field yet.

B.29.16 outcome.success #

  • Type: bool
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

Whether the operation succeeded. What counts as success narrows per event; read the event's own note before computing a rate over it.

Carried by:

B.29.17 outcome.verdict #

  • Type: str.enum
  • Values: pass · reject · drop
  • Set: closed
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

The decision a policy engine reached, where the decision has more than two states and outcome.success cannot express it. reject and drop both refuse, and differ in whether the refusal is signalled back to the sender or the traffic is discarded silently.

Carried by:

B.29.18 outcome.verdict-previous #

  • Type: str.enum
  • Values: pass · reject · drop
  • Set: closed
  • Asserted: no
  • Carried in: the payload
  • Defined in: kernel.evman

The verdict a flow's cached judgment held before it was judged again. Set beside outcome.verdict, the pair is what tells a reload that changed a live connection's fate, such as pass to drop, from the far commoner re-judgment that changed nothing.

Carried by:

No event carries this field yet.

Generated from kernel.evman by pkm/tools/gen-events-book.py. Edit the fragment, not this page.

Edit this page