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>
5.6 KiB
5.6 KiB
mulhwx — Multiply High Word
Category: Integer ALU · Form: XO · Opcode:
0x7c000096
Assembler Mnemonics
| Mnemonic | XML entry | Flags | Description |
|---|---|---|---|
mulhw |
mulhwx |
— | Multiply High Word |
mulhw. |
mulhwx |
Rc=1 | Multiply High Word |
Syntax
mulhw[Rc] [RD], [RA], [RB]
Encoding
mulhwx — form XO
- Opcode word:
0x7c000096 - Primary opcode (bits 0–5):
31 - Extended opcode:
75 - 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 |
mulhwx: read | Source GPR (r0–r31). |
RB |
mulhwx: read | Source GPR. |
RD |
mulhwx: write | Destination GPR. |
CR |
mulhwx: 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
mulhwx
- Reads (always):
RA,RB - Reads (conditional): none
- Writes (always):
RD - Writes (conditional):
CR
Status-Register Effects
mulhwx: CR0 ← signed-compare(result, 0) withSO ← XER[SO], whenRc=1.
Operation (pseudocode)
RT <- high_32_of_signed_multiply((RA)[32:63], (RB)[32:63]) sign-extended to 64
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
mulhwx
- Canary XML:
tools/ppc-instructions.xml— search formnem="mulhwx" - Canary emitter:
src/xenia/cpu/ppc/ppc_emit_alu.cc:326 - Sylpheed opcode:
crates/sylpheed-ppc/src/opcode.rs:191 - Sylpheed decoder:
crates/sylpheed-ppc/src/decoder.rs:980
Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_mulhwx(PPCHIRBuilder& f, const InstrData& i) {
// RT[32:64] <- ((RA)[32:63] × (RB)[32:63])[0:31]
if (i.XO.OE) {
// With XER update.
XEINSTRNOTIMPLEMENTED();
}
Value* ratrunc =
f.SignExtend(f.Truncate(f.LoadGPR(i.XO.RA), INT32_TYPE), INT64_TYPE);
Value* rbtrunc =
f.SignExtend(f.Truncate(f.LoadGPR(i.XO.RB), INT32_TYPE), INT64_TYPE);
Value* v = f.Sha(f.Mul(ratrunc, rbtrunc), 32);
f.StoreGPR(i.XO.RT, v);
if (i.XO.Rc) {
f.UpdateCR(0, v);
}
return 0;
}
Special Cases & Edge Conditions
- Inputs are the low 32 bits, signed-extended.
RA[32:63]andRB[32:63]are sign-extended to 64-bit signed values, multiplied, and the high 32 bits of the 64-bit product are returned inRT[32:63]. The high 32 bits ofRTare implementation-defined per spec but xenia masks them to zero (interpreter.rs:222& 0xFFFF_FFFF). - Pair with
mullwxfor the full 64-bit product. Both can issue independently — no fused 32×32→64 instruction. - No
OEbit. Like allmulh*instructions, no overflow flag is produced; the high half is by definition defined. - Xenia-rs quirk: high 32 bits zeroed. Because spec says they're "undefined", legitimately matching either zero, sign-extension, or garbage. Xenia chooses zero, which differs from the literal Xenon behaviour (which sign-extends in some microarchitecture cases). For game code that doesn't read those bits, the difference is invisible.
Rc=1CR0 update.interpreter.rs:225usesas i32 as i64— operates on the truncated low 32 bits, which is correct for the defined portion of the result.- Multi-cycle latency. Multiply is the slowest pipelined ALU op;
mulhwshares the divider/multiplier unit.
Related Instructions
mullwx— low 32 bits of a signed 32×32 product.mulhwux— high 32 bits, unsigned interpretation.mulhdx,mulhdux,mulldx— 64-bit family.divwx— sometimes replaced by reciprocal-mul-then-shift in compiled code.