Files
Sylpheed/tools/ppc-manual/alu/addex.md
sim dedcf37867 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.0 KiB
Raw Blame History

addex — Add Extended

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

Assembler Mnemonics

Mnemonic XML entry Flags Description
adde addex Add Extended
addeo addex OE=1 Add Extended
adde. addex Rc=1 Add Extended
addeo. addex OE=1, Rc=1 Add Extended

Syntax

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

Encoding

addex — form XO

  • Opcode word: 0x7c000114
  • Primary opcode (bits 05): 31
  • Extended opcode: 138
  • 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 addex: read Source GPR (r0r31).
RB addex: read Source GPR.
CA addex: read XER[CA] carry bit. Read by add-with-carry/subtract-with-borrow instructions, written by carrying instructions.
RD addex: write Destination GPR.
OE addex: write (conditional) Overflow-enable bit. When 1, the instruction updates XER[OV] and stickies XER[SO] on signed overflow.
CR addex: 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

addex

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

Status-Register Effects

  • addex: 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) + CA
CA <- carry_out_of_the_add

C Translation Example

/* No hand-written C yet. Translate the Canary emitter snapshot   */
/* under Implementation References; its HIR maps directly:        */
/*   f.LoadGPR(n) / f.StoreGPR(n, v)  -> r[n] / r[n] = v          */
/*   f.LoadFPR / StoreFPR, f.LoadVR / StoreVR -> f[n], v[n]        */
/*   f.Load(ea, T), f.Store(ea, v) -> raw read / write; emitters   */
/*     wrap them in f.ByteSwap for the big-endian guest value      */
/*   f.UpdateCR(n, v)  -> CR field n from v's LOW 32 BITS vs 0     */
/*   f.LoadCA / f.StoreCA -> xer.CA;  f.StoreSAT -> vscr.SAT       */
/*   i.XO.RA, i.D.DS, ... -> the bit-fields listed under Operands  */
/* The Register Effects and Status-Register Effects tables above  */
/* enumerate every side effect a faithful translation must emit.  */

Implementation References

addex

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_addex(PPCHIRBuilder& f, const InstrData& i) {
  // RD <- (RA) + (RB) + XER[CA]
  // CA <- carry bit
  Value* ra = f.LoadGPR(i.XO.RA);
  Value* rb = f.LoadGPR(i.XO.RB);
  Value* v = f.AddWithCarry(ra, rb, f.LoadCA());
  f.StoreGPR(i.XO.RT, v);
  f.StoreCA(AddWithCarryDidCarry(f, ra, rb, f.LoadCA()));
  if (i.XO.Rc) {
    f.UpdateCR(0, v);
  }
  if (i.XO.OE) {
    // Stub implementation.
    // TODO: Handle overflow flag.
    // NOTE: 535507D4 (Raiden Fighters Aces) never seems to rely on this
    //   behavior either, despite OE being set.
  }
  return 0;
}

Special Cases & Edge Conditions

  • Carry-in is consumed and carry-out is produced. addex is the middle link of a multi-word add chain seeded by addcx: RT ← RA + RB + XER[CA], then XER[CA] ← carry_out.
  • Carry-out detection handles both edges. Xenia checks result < ra OR (ca != 0 && result == ra) — that second clause covers the case where adding the carry-in alone causes the result to exactly equal RA (i.e. RB == ~0 && CA == 1), which still constitutes overflow. The naive result < ra test misses it.
  • No trap on signed overflow. addeo/addeo. only update XER[OV] and sticky XER[SO]; xenia-rs leaves the OE branch unimplemented.
  • 64-bit CR update on Xenon, 32-bit in xenia-rs. The Rc=1 arm uses result as i32 as i64. For multi-word adds whose final word is the high 32 bits of a 64-bit value, this distinction matters; see addx.
  • XER[CA] must be initialised by an earlier addcx, subfcx, or mtspr to XER. Reading stale CA from an unrelated instruction is the most common bug in hand-written multi-word arithmetic.
  • XER[SO] is sticky until cleared by mcrxr; Rc=1 copies it into CR0[SO].
  • addcx — seeds the carry chain (no CA read, sets CA).
  • addmex, addzex — terminate the chain (RA + 1 + CA, RA + 0 + CA).
  • addx — plain add without XER[CA].
  • subfex — dual: ~RA + RB + XER[CA], used for multi-word subtract.
  • addic / addicx — immediate carrying adds that initialise a chain.

IBM Reference