Files

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

5.2 KiB

Raw Permalink Blame History

`vmladduhm` — Vector Multiply-Low and Add Unsigned Half Word Modulo

Category: VMX (Altivec) · Form: VA · Opcode: 0x10000022

Assembler Mnemonics

Mnemonic	XML entry	Flags	Description
`vmladduhm`	`vmladduhm`	—	Vector Multiply-Low and Add Unsigned Half Word Modulo

Syntax

vmladduhm [VD], [VA], [VB], [VC]

Encoding

`vmladduhm` — form `VA`

Opcode word: 0x10000022
Primary opcode (bits 0–5): 4
Extended opcode: 34
Synchronising: no

Bits	Field	Meaning
0–5	`OPCD`	primary opcode (4)
6–10	`VRT`	destination vector register
11–15	`VRA`	source A
16–20	`VRB`	source B
21–25	`VRC`	source C / shift
26–31	`XO`	extended opcode (6 bits)

Operands

Field	Role	Description
`VA`	vmladduhm: read	Source A vector register.
`VB`	vmladduhm: read	Source B vector register.
`VC`	vmladduhm: read	Source C vector register / 3-bit selector.
`VD`	vmladduhm: write	Destination vector register.

Register Effects

`vmladduhm`

Reads (always): VA, VB, VC
Reads (conditional): none
Writes (always): VD
Writes (conditional): none

Status-Register Effects

No condition-register or status-register effects.

Operation (pseudocode)

; No hand-written pseudocode for this instruction yet.
; The authoritative semantics are the Canary emitter snapshot under
; Implementation References; about half of Canary's emitters open
; with the PPC-style definition as a comment (`RD <- (RA) + (RB)`).
; Every side effect is also enumerated in the Register Effects and
; Status-Register Effects tables above.

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

vmladduhm

Canary XML: tools/ppc-instructions.xml — search for mnem="vmladduhm"
Canary emitter: src/xenia/cpu/ppc/ppc_emit_altivec.cc:938
Sylpheed opcode: crates/sylpheed-ppc/src/opcode.rs:368
Sylpheed decoder: crates/sylpheed-ppc/src/decoder.rs:693

Canary emitter (frozen snapshot @ f21ebd49e9)

int InstrEmit_vmladduhm(PPCHIRBuilder& f, const InstrData& i) {
  XEINSTRNOTIMPLEMENTED();
  return 1;
}

Special Cases & Edge Conditions

Modulo multiply-low add. Eight half-word lanes; per lane:
```
VD[i] = (uint16(VA[i]) * uint16(VB[i]) + uint16(VC[i])) mod 2^16
```
Only the low 16 bits of the 32-bit product survive — the "ml" in the mnemonic = "multiply low" (versus vmh* for "multiply high"). This is the fastest of the multiply-add family because nothing saturates and nothing rounds.
Sign-agnostic. Modulo multiply for signed int16 and unsigned u16 is bit-identical at the low 16 bits, so this single instruction serves both.
No VSCR[SAT] change. Wrap is silent.
No XER, no exceptions.
Big-endian half lanes. Lane 0 is the most-significant half.
Aliasing legal. vmladduhm v3, v3, v4, v3 is the standard accumulate idiom (same register as both VA and VC).
No VMX128 sibling.
Common usage. Stride / index computation in vector loops, RGBA8 component recombination after a vupkhsb, per-element polynomial evaluation at half precision.

vmhaddshs — saturating high-half signed multiply-add (Q15).
vmhraddshs — same, with rounding.
vmsumuhm, vmsummbm — multiply-sum across pairs of lanes.
vadduhm, vmaxuh — companion modulo / max ops at half width.

5.2 KiB Raw Permalink Blame History Unescape Escape

vmladduhm — Vector Multiply-Low and Add Unsigned Half Word Modulo

Assembler Mnemonics

Syntax

Encoding

vmladduhm — form VA

Operands

Register Effects

vmladduhm

Status-Register Effects

Operation (pseudocode)

C Translation Example

Implementation References

Special Cases & Edge Conditions

Related Instructions

IBM Reference

5.2 KiB

Raw Permalink Blame History

`vmladduhm` — Vector Multiply-Low and Add Unsigned Half Word Modulo

`vmladduhm` — form `VA`

`vmladduhm`