Files
Sylpheed/tools/ppc-manual/alu/addx.md
sim 7f8a81b8f8
All checks were successful
CI / Native — linux (pull_request) Successful in 2h2m37s
CI / WASM — Web (pull_request) Successful in 30m13s
CI / Formatting (pull_request) Successful in 1m23s
docs(ppc-manual): quote Canary and our own decoder, not the retired xenia-rs
The generator had not been able to run correctly since the manual moved into
`tools/ppc-manual/`: it computed the repository root as `HERE.parent.parent`,
which now names `tools/`, so the XML, Canary's emitters and xenia-rs all stopped
resolving — silently, because both scrapers skipped what they could not find.
Every page's references had been pointing at paths that exist nowhere.

What each source contributed, measured on the 350 pages before this change:

  Operation (pseudocode)  251 pages: fixed boilerplate "derives from the xenia-rs
                          interpreter"; 99 carry real hand-written seeds
  C translation           337 pages: the same kind of boilerplate
  xenia-rs snapshot       336 pages: the interpreter arm, pasted in — the only
                          per-instruction semantics on unseeded pages
  links                   xenia-rs opcode/decoder/interpreter + Canary emitter

Now:

  * semantics come from **Xenia Canary**, the reference emulator, read through
    `git show` at a pinned upstream commit (`origin/canary_experimental`,
    f21ebd49e9). Not our checkout: it carries instrumentation and lacked
    upstream's `mcrf` fix, so it would have published probes and a wrong `mcrf`.
    Each page embeds the emitter (`InstrEmit_<mnem>`), and for the 128 pure
    one-line delegations also the helper that holds the semantics.
  * decode references point at `crates/sylpheed-ppc` — the decoder that
    produces `sylpheed.db` — as in-repo relative links.
  * the boilerplate now says what is true, and the C translation guide maps
    Canary's actual HIR calls, checked against `ppc_hir_builder.h` (including
    that `UpdateCR(n, v)` truncates to 32 bits).
  * `rust_scraper.py` -> `decoder_scraper.py` (interpreter half dropped);
    missing sources are now errors, not empty results.

Verified:

  consistency checks        455 XML entries, 350 families, 598 index keys
  hand-written tails        386/386 byte-identical after regeneration
  xenia-rs in generated     0
  pages with a snapshot     349/350 (was 336) — `dcbi` has no Canary emitter at all
  in-repo decoder links     910/910 resolve to a line holding the identifier
  emitter boundaries        brace counter == column-0 `}` rule on 521/521;
                            preprocessor model unit-tested (#if 0/#else/#elif)
  idempotency               re-run: 0 pages updated, 0 working-tree changes

Hand-written notes (outside the generated regions) are not rewritten here:

  * 110 links into `../../xenia-rs/...` were dead; they now point at the file in
    the archived repository (git.mc02.dev/fabi/xenia-rs @ 8401d4d). Line anchors
    were dropped because the notes predate that commit — 0 of 441 old line
    ranges match it — and a precise-looking wrong anchor is worse than none. The
    link text, which carries the author's line numbers, is unchanged.
  * 140 prose claims about xenia-rs's behaviour remain. 23 are verified to hold
    for Canary too (the 32-bit CR0 truncation, OE left unimplemented); the other
    114 need checking one by one, and some invert — e.g. `divdx` notes a correct
    64-bit CR0 update in xenia-rs where Canary's `UpdateCR` truncates. Left for
    a deliberate pass rather than a blind substitution.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-16 20:34:34 +02:00

6.2 KiB
Raw Blame History

addx — Add

Category: Integer ALU · Form: XO · Opcode: 0x7c000214

Assembler Mnemonics

Mnemonic XML entry Flags Description
add addx Add
addo addx OE=1 Add
add. addx Rc=1 Add
addo. addx OE=1, Rc=1 Add

Syntax

add[OE][Rc] [RD], [RA], [RB]

Encoding

addx — form XO

  • Opcode word: 0x7c000214
  • Primary opcode (bits 05): 31
  • Extended opcode: 266
  • Synchronising: no
Bits Field Meaning
05 OPCD primary opcode (31)
610 RT destination GPR
1115 RA source A
1620 RB source B
21 OE overflow-enable flag
2230 XO extended opcode (9 bits)
31 Rc record-form flag

Operands

Field Role Description
RA addx: read Source GPR (r0r31).
RB addx: read Source GPR.
RD addx: write Destination GPR.
OE addx: write (conditional) Overflow-enable bit. When 1, the instruction updates XER[OV] and stickies XER[SO] on signed overflow.
CR addx: write (conditional) Condition-register update. When Rc=1, CR field 0 (or CR6 for vector compares, CR1 for FPU) is updated from the result.

Register Effects

addx

  • Reads (always): RA, RB
  • Reads (conditional): none
  • Writes (always): RD
  • Writes (conditional): OE, CR

Status-Register Effects

  • addx: CR0 ← signed-compare(result, 0) with SO ← XER[SO], when Rc=1.; XER[OV] ← signed-overflow(result); XER[SO] stickies, when OE=1.

Operation (pseudocode)

RT <- (RA) + (RB)

C Translation Example

/* add / add. / addo / addo.  (XO-form)                         */
uint64_t a = r[insn.RA], b = r[insn.RB];
uint64_t result = a + b;
r[insn.RT] = result;
if (insn.OE) { bool ov = (~(a ^ b) & (a ^ result)) >> 63;
               if (ov) { xer.OV = 1; xer.SO = 1; } else xer.OV = 0; }
if (insn.Rc) update_cr0_signed((int64_t)result);

Implementation References

addx

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_addx(PPCHIRBuilder& f, const InstrData& i) {
  // RD <- (RA) + (RB)
  Value* v = f.Add(f.LoadGPR(i.XO.RA), f.LoadGPR(i.XO.RB));
  f.StoreGPR(i.XO.RT, v);
  if (i.XO.OE) {
    XEINSTRNOTIMPLEMENTED();
    // e.update_xer_with_overflow(EFLAGS OF?);
  }
  if (i.XO.Rc) {
    f.UpdateCR(0, v);
  }
  return 0;
}

Extended Pseudocode

RT <- (RA) + (RB)                                ; modulo 2^64, carry discarded
if OE then
    XER[OV] <- (~(RA ^ RB) & (RA ^ RT))[0]       ; signed overflow: same-sign inputs, opposite-sign result
    XER[SO] <- XER[SO] | XER[OV]
if Rc then
    CR0[LT,GT,EQ] <- signed_compare(RT, 0)        ; 64-bit comparison on the Xenon
    CR0[SO]      <- XER[SO]

Special Cases & Edge Conditions

  • No trap on overflow. addo / addo. record overflow in XER[OV] and sticky-set XER[SO]. A trap can only be produced by a separate td/tw instruction examining the result.
  • Signed-overflow predicate. Overflow occurs iff both addends share a sign bit and the result has the opposite sign bit: OV = ((~(a ^ b)) & (a ^ rt)) >> 63. Unsigned carry is not tracked — use addcx when you need XER[CA].
  • XER[SO] is sticky. Once set, it remains set until cleared by mcrxr. The . record forms copy it into CR0[SO].
  • 64-bit CR update on Xenon. The Xbox 360 Xenon CPU is 64-bit, so add. compares the full 64-bit result against zero. Xenia-rs presently truncates to 32 bits before the CR update (result as i32 as i64 in interpreter.rs:95). If your translator must match xenia bit-for-bit, emit a 32-bit compare; if it must be spec-correct, emit a 64-bit compare. Most Xbox 360 object code works either way because results that overflow 32 bits are rare outside of explicit 64-bit math.
  • OE overflow detection not emulated in xenia-rs. The addo / addo. branch in interpreter.rs is a TODO stub. A faithful translator should still emit the overflow check — titles rarely observe XER[OV], but it's occasionally used by profiling / sanity-checking code paths.
  • Operand aliasing. add r3, r3, r3, add r3, r3, r4, add r3, r4, r3 are all legal. The addition reads both source operands before writing RT.
  • No immediate form. For RT = RA + imm use addi / addis. Those are distinct opcodes, not a flag on add.
  • addcx — produces the carry-out in XER[CA].
  • addex — sums (RA) + (RB) + XER[CA] (carry-in chain).
  • addmex, addzex — add to 1 or 0 with carry-in (used to propagate borrows across multiword subtracts).
  • addi, addis — D-form immediate adds; no Rc/OE.
  • addic, addicx — D-form adds that set XER[CA].
  • subfx — the dual: RT ← (RB) (RA).
  • negx — two's-complement negate.

IBM Reference