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>
6.2 KiB
6.2 KiB
addcx — Add Carrying
Category: Integer ALU · Form: XO · Opcode:
0x7c000014
Assembler Mnemonics
| Mnemonic | XML entry | Flags | Description |
|---|---|---|---|
addc |
addcx |
— | Add Carrying |
addco |
addcx |
OE=1 | Add Carrying |
addc. |
addcx |
Rc=1 | Add Carrying |
addco. |
addcx |
OE=1, Rc=1 | Add Carrying |
Syntax
addc[OE][Rc] [RD], [RA], [RB]
Encoding
addcx — form XO
- Opcode word:
0x7c000014 - Primary opcode (bits 0–5):
31 - Extended opcode:
10 - Synchronising: no
| Bits | Field | Meaning |
|---|---|---|
| 0–5 | OPCD |
primary opcode (31) |
| 6–10 | RT |
destination GPR |
| 11–15 | RA |
source A |
| 16–20 | RB |
source B |
| 21 | OE |
overflow-enable flag |
| 22–30 | XO |
extended opcode (9 bits) |
| 31 | Rc |
record-form flag |
Operands
| Field | Role | Description |
|---|---|---|
RA |
addcx: read | Source GPR (r0–r31). |
RB |
addcx: read | Source GPR. |
RD |
addcx: write | Destination GPR. |
CA |
addcx: write | XER[CA] carry bit. Read by add-with-carry/subtract-with-borrow instructions, written by carrying instructions. |
OE |
addcx: write (conditional) | Overflow-enable bit. When 1, the instruction updates XER[OV] and stickies XER[SO] on signed overflow. |
CR |
addcx: 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
addcx
- Reads (always):
RA,RB - Reads (conditional): none
- Writes (always):
RD,CA - Writes (conditional):
OE,CR
Status-Register Effects
addcx: CR0 ← signed-compare(result, 0) withSO ← XER[SO], whenRc=1.; XER[OV] ← signed-overflow(result); XER[SO] stickies, whenOE=1.; XER[CA] ← carry-out of the add / borrow-in of the subtract (always).
Operation (pseudocode)
RT <- (RA) + (RB)
CA <- carry_out_of_32_or_64_bit_add((RA), (RB))
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
addcx
- Canary XML:
tools/ppc-instructions.xml— search formnem="addcx" - Canary emitter:
src/xenia/cpu/ppc/ppc_emit_alu.cc:64 - Sylpheed opcode:
crates/sylpheed-ppc/src/opcode.rs:8 - Sylpheed decoder:
crates/sylpheed-ppc/src/decoder.rs:976
Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_addcx(PPCHIRBuilder& f, const InstrData& i) {
// RD <- (RA) + (RB)
// CA <- carry bit
Value* ra = f.LoadGPR(i.XO.RA);
Value* rb = f.LoadGPR(i.XO.RB);
Value* v = f.Add(ra, rb);
f.StoreGPR(i.XO.RT, v);
if (i.XO.OE) {
XEINSTRNOTIMPLEMENTED();
// e.update_xer_with_overflow(EFLAGS OF?);
} else {
f.StoreCA(AddDidCarry(f, ra, rb));
}
if (i.XO.Rc) {
f.UpdateCR(0, v);
}
return 0;
}
Special Cases & Edge Conditions
- Carry-out is mandatory.
XER[CA]is updated unconditionally —addcxexists to produce the carry. It seeds a multi-word add chain that continues withaddexfor middle words andaddzex/addmexfor the final word. - Carry detection by overflow comparison. Xenia computes
CA = (result < RA)— the standard unsigned-add overflow test. Equivalent toCA = (RA + RB) >> 64mathematically. This is correct for the 64-bit operand width that the Xenon implements; the spec also allows a 32-bit width selected by the implementation but the 970/Xenon use 64-bit add throughout. - No trap on signed overflow.
addco/addco.only setXER[OV]and stickyXER[SO]; they do not raise an exception. Xenia-rs leaves theOEbranch as a// TODO(seeaddxfor the same gap). - 64-bit CR update on Xenon, 32-bit in xenia-rs. The
Rc=1CR0 compare readsresult as i32 as i64ininterpreter.rs:97; spec demands the full 64-bit signed compare. Flag this as a xenia-rs quirk if you need bit-exact behaviour. XER[SO]is sticky — onlymcrxrclears it. TheRc=1form folds it intoCR0[SO].- Operand aliasing is legal, just like
addx.addc r3, r3, r3simply doublesr3and records whether the result wrapped.
Related Instructions
addx— same operation, but does not updateXER[CA].addex—RA + RB + XER[CA]; chains a multi-word add afteraddcx.addmex,addzex— terminate a carry chain by adding−1or0toXER[CA].addic,addicx— D-form immediate variants that also writeXER[CA].subfcx— the dual: produces a borrow-out inXER[CA].
IBM Reference
- AIX 7.3 —
addc(Add Carrying) - PowerISA v2.07B, Book I, §3.3.8 — Fixed-Point Add with Carry; defines
XER[CA]semantics independent of operand width.