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

10 KiB
Raw Blame History

stw — Store Word

Category: Memory · Form: D · Opcode: 0x90000000

Assembler Mnemonics

Mnemonic XML entry Flags Description
stw stw — Store Word
stwu stwu — Store Word with Update
stwux stwux — Store Word with Update Indexed
stwx stwx — Store Word Indexed

Syntax

stw [RS], [d]([RA0])
stwu [RS], [d]([RA])
stwux [RS], [RA], [RB]
stwx [RS], [RA0], [RB]

Encoding

stw — form D

  • Opcode word: 0x90000000
  • Primary opcode (bits 0–5): 36
  • Extended opcode: —
  • Synchronising: no
Bits Field Meaning
0–5 OPCD primary opcode
6–10 RT destination GPR (or RS when storing)
11–15 RA source GPR (0 ⇒ literal 0 for RA0 forms)
16–31 D/SI/UI 16-bit signed or unsigned immediate

stwu — form D

  • Opcode word: 0x94000000
  • Primary opcode (bits 0–5): 37
  • Extended opcode: —
  • Synchronising: no
Bits Field Meaning
0–5 OPCD primary opcode
6–10 RT destination GPR (or RS when storing)
11–15 RA source GPR (0 ⇒ literal 0 for RA0 forms)
16–31 D/SI/UI 16-bit signed or unsigned immediate

stwux — form X

  • Opcode word: 0x7c00016e
  • Primary opcode (bits 0–5): 31
  • Extended opcode: 183
  • 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

stwx — form X

  • Opcode word: 0x7c00012e
  • Primary opcode (bits 0–5): 31
  • Extended opcode: 151
  • 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

Operands

Field Role Description
RS stw: read; stwu: read; stwux: read; stwx: read Source GPR (alias for RD in some stores).
RA0 stw: read; stwx: read Source GPR; when the encoded register number is 0 the operand is the literal 64-bit zero, not r0.
d stw: read; stwu: read 16-bit signed displacement (d) added to the base address register.
RA stwu: read; stwu: write; stwux: read; stwux: write Source GPR (r0–r31).
RB stwux: read; stwx: read Source GPR.

Register Effects

stw

  • Reads (always): RS, RA0, d
  • Reads (conditional): none
  • Writes (always): none
  • Writes (conditional): none

stwu

  • Reads (always): RS, RA, d
  • Reads (conditional): none
  • Writes (always): RA
  • Writes (conditional): none

stwux

  • Reads (always): RS, RA, RB
  • Reads (conditional): none
  • Writes (always): RA
  • Writes (conditional): none

stwx

  • Reads (always): RS, 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) + EXTS(d)
MEM(EA, 4) <- (RS)[32:63]

C Translation Example

/* stw RS, d(RA)                                                   */
uint64_t base = (insn.RA == 0) ? 0 : r[insn.RA];
uint32_t ea   = (uint32_t)(base + (int64_t)(int16_t)insn.D);
mem_write_u32_be(ea, (uint32_t)r[insn.RS]);

Implementation References

stw

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_stw(PPCHIRBuilder& f, const InstrData& i) {
  // if RA = 0 then
  //   b <- 0
  // else
  //   b <- (RA)
  // EA <- b + EXTS(D)
  // MEM(EA, 4) <- (RS)[32:63]
  Value* b;
  if (i.D.RA == 0) {
    b = f.LoadZeroInt64();
  } else {
    b = f.LoadGPR(i.D.RA);
  }
  Value* offset = f.LoadConstantInt64(XEEXTS16(i.D.DS));
  f.StoreOffset(b, offset,
                f.ByteSwap(f.Truncate(f.LoadGPR(i.D.RT), INT32_TYPE)));

  return 0;
}

stwu

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_stwu(PPCHIRBuilder& f, const InstrData& i) {
  // EA <- (RA) + EXTS(D)
  // MEM(EA, 4) <- (RS)[32:63]
  // RA <- EA
  Value* ea = CalculateEA_i(f, i.D.RA, XEEXTS16(i.D.DS));
  f.Store(ea, f.ByteSwap(f.Truncate(f.LoadGPR(i.D.RT), INT32_TYPE)));
  StoreEA(f, i.D.RA, ea);
  return 0;
}

stwux

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_stwux(PPCHIRBuilder& f, const InstrData& i) {
  // EA <- (RA) + (RB)
  // MEM(EA, 4) <- (RS)[32:63]
  // RA <- EA
  Value* ea = CalculateEA(f, i.X.RA, i.X.RB);
  f.Store(ea, f.ByteSwap(f.Truncate(f.LoadGPR(i.X.RT), INT32_TYPE)));
  StoreEA(f, i.X.RA, ea);
  return 0;
}

stwx

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_stwx(PPCHIRBuilder& f, const InstrData& i) {
  // if RA = 0 then
  //   b <- 0
  // else
  //   b <- (RA)
  // EA <- b + (RB)
  // MEM(EA, 4) <- (RS)[32:63]
  Value* ea = CalculateEA_0(f, i.X.RA, i.X.RB);
  f.Store(ea, f.ByteSwap(f.Truncate(f.LoadGPR(i.X.RT), INT32_TYPE)));
  return 0;
}

Special Cases & Edge Conditions

  • Stores low 32 bits of RS. Writes (RS)[32:63] — the low word of the 64-bit GPR — at EA. The xenia snapshot does mem.write_u32(ea, ctx.gpr[instr.rs()] as u32). The high 32 bits are silently truncated; use std to store all 64 bits.
  • Big-endian write. RS[32:39] (the most-significant byte of the low word) lands at EA; RS[56:63] at EA+3. On little-endian hosts the byte-swap happens at the memory boundary.
  • RA0 (non-update forms). RA = 0 in stw and stwx selects literal zero. Update forms stwu / stwux invoke RA = 0 as an invalid form. The classic frame-allocation idiom stwu r1, -framesize(r1) exploits the update form: it writes the old SP at the new SP and updates r1 in one instruction.
  • Update-form post-write. stwu / stwux write EA to RA after the store. Order is store-then-update, so the new RA value reflects the post-update address (typically the new stack-frame base).
  • No alignment requirement. Xenon tolerates unaligned word stores. PowerISA permits implementations to raise alignment exceptions on cache-inhibited storage.
  • Cache-line behaviour. A word store fits inside one Xenon cache line (128 B). Stores that straddle a line boundary touch two lines; keep words 4-byte aligned for best performance.
  • Common as pointer / ABI store. Standard store for any int32_t/uint32_t/pointer field (Xbox 360 user pointers are 32-bit) and the workhorse of stack-frame setup.

IBM Reference