Files
Sylpheed/tools/ppc-manual/memory/stvx.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

7.4 KiB
Raw Blame History

stvx — Store Vector Indexed

Category: Memory · Form: X · Opcode: 0x7c0001ce

Assembler Mnemonics

Mnemonic XML entry Flags Description
stvx stvx — Store Vector Indexed
stvx128 stvx128 — Store Vector Indexed 128

Syntax

stvx [VS], [RA0], [RB]
stvx128 [VS], [RA0], [RB]

Encoding

stvx — form X

  • Opcode word: 0x7c0001ce
  • Primary opcode (bits 0–5): 31
  • Extended opcode: 231
  • Synchronising: no
Bits Field Meaning
0–5 OPCD primary opcode
6–10 RT/FRT/VRT destination
11–15 RA/FRA/VRA source A
16–20 RB/FRB/VRB source B
21–30 XO extended opcode (10 bits)
31 Rc record-form flag

stvx128 — form VX128_1

  • Opcode word: 0x100001c3
  • Primary opcode (bits 0–5): 4
  • Extended opcode: 451
  • Synchronising: no
Bits Field Meaning
0–5 OPCD primary opcode (4)
6–10 VD128l destination low 5 bits
11–15 RA address register
16–20 RB offset register
21–27 XO extended opcode
28–29 VD128h destination high 2 bits
30–31 — reserved

Operands

Field Role Description
VS stvx: read; stvx128: read Source vector register (alias for VD on stores).
RA0 stvx: read; stvx128: read Source GPR; when the encoded register number is 0 the operand is the literal 64-bit zero, not r0.
RB stvx: read; stvx128: read Source GPR.

Register Effects

stvx

  • Reads (always): VS, RA0, RB
  • Reads (conditional): none
  • Writes (always): none
  • Writes (conditional): none

stvx128

  • Reads (always): VS, RA0, RB
  • Reads (conditional): none
  • Writes (always): none
  • Writes (conditional): none

Status-Register Effects

No condition-register or status-register effects.

Operation (pseudocode)

EA <- ((RA|0) + (RB)) & ~0xF           ; align to 16
MEM(EA, 16) <- byteswap(VS)

C Translation Example

/* stvx VS, RA, RB — 16-byte aligned store of a vector register    */
uint64_t base = (insn.RA == 0) ? 0 : r[insn.RA];
uint32_t ea   = (uint32_t)((base + r[insn.RB]) & ~(uint64_t)0xF);
mem_write_vec128_be(ea, v[insn.VS]);

Implementation References

stvx

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_stvx(PPCHIRBuilder& f, const InstrData& i) {
  return InstrEmit_stvx_(f, i, i.X.RT, i.X.RA, i.X.RB);
}

// ── delegates to (src/xenia/cpu/ppc/ppc_emit_altivec.cc:187) ──
int InstrEmit_stvx_(PPCHIRBuilder& f, const InstrData& i, uint32_t vd,
                    uint32_t ra, uint32_t rb) {
  Value* ea = f.And(CalculateEA_0(f, ra, rb), f.LoadConstantUint64(~0xFull));
  f.Store(ea, f.ByteSwap(f.LoadVR(vd)));
  return 0;
}

stvx128

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_stvx128(PPCHIRBuilder& f, const InstrData& i) {
  return InstrEmit_stvx_(f, i, VX128_1_VD128, i.VX128_1.RA, i.VX128_1.RB);
}

// ── delegates to (src/xenia/cpu/ppc/ppc_emit_altivec.cc:187) ──
int InstrEmit_stvx_(PPCHIRBuilder& f, const InstrData& i, uint32_t vd,
                    uint32_t ra, uint32_t rb) {
  Value* ea = f.And(CalculateEA_0(f, ra, rb), f.LoadConstantUint64(~0xFull));
  f.Store(ea, f.ByteSwap(f.LoadVR(vd)));
  return 0;
}

Extended Pseudocode

EA <- ((RA|0) + (RB)) & ~0xF                   ; force 16-byte alignment
MEM(EA, 16) <- byte_order_adjusted(VS)         ; lane 0 at EA, lane 15 at EA+15

Special Cases & Edge Conditions

  • Alignment is forced, not checked. The low four bits of the effective address are cleared before the store — alignment violations silently corrupt adjacent data rather than trap. This differs from scalar stw (no alignment enforcement) and from stvewx (which stores only one element and keeps the exact EA).
  • Big-endian lane layout. Vector lane 0 (the most-significant bytes of the 128-bit register) lives at the lowest address; lane 15 at EA + 15. On little-endian hosts the whole 16-byte block is byte-swapped at the memory boundary so the PowerPC-visible layout is preserved. Xenia's helper mem_write_vec128_be handles this.
  • RA0 semantics. When RA = 0 the base is the literal zero — just like scalar loads/stores. Combined with the alignment mask this lets stvx VS, 0, RB store to address RB & ~0xF.
  • No update form. Unlike scalar stores, VMX stores have no u variant that post-writes the base. Use stvxl for the cache-hint variant (suggests "last" — the line is not expected to be reused soon).
  • VMX128 sibling (stvx128). Identical semantics; the only difference is the operand encoding. VMX128 uses a 7-bit register index split across three non-contiguous bit fields (VS128l ‖ VS128h) so it can address v0..v127 instead of the 32-register Altivec space. All alignment, byte-order and RA0 rules are the same.
  • Read-before-write. The 16-byte write occurs as one conceptual store; subsequent loads from the same address observe the complete new value. There's no split-transaction window visible to software.
  • lvx, lvx128 — the load counterparts.
  • stvxl, stvxl128 — cache-hint "last-use" variants.
  • stvebx / stvehx / stvewx — store single element (byte / half / word) at the exact (unaligned) address.
  • stvlx / stvrx — store-left / store-right for unaligned vector I/O.
  • dcbz — zero a cache line; often paired with stvx in block-fill idioms.

IBM Reference