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>
11 KiB
11 KiB
lwz — Load Word and Zero
Assembler Mnemonics
| Mnemonic | XML entry | Flags | Description |
|---|---|---|---|
lwz |
lwz |
— | Load Word and Zero |
lwzu |
lwzu |
— | Load Word and Zero with Update |
lwzux |
lwzux |
— | Load Word and Zero with Update Indexed |
lwzx |
lwzx |
— | Load Word and Zero Indexed |
Syntax
lwz [RD], [d]([RA0])
lwzu [RD], [d]([RA])
lwzux [RD], [RA], [RB]
lwzx [RD], [RA0], [RB]
Encoding
lwz — form D
- Opcode word:
0x80000000 - Primary opcode (bits 0–5):
32 - 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 |
lwzu — form D
- Opcode word:
0x84000000 - Primary opcode (bits 0–5):
33 - 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 |
lwzux — form X
- Opcode word:
0x7c00006e - Primary opcode (bits 0–5):
31 - Extended opcode:
55 - 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 |
lwzx — form X
- Opcode word:
0x7c00002e - Primary opcode (bits 0–5):
31 - Extended opcode:
23 - 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 |
|---|---|---|
RA0 |
lwz: read; lwzx: read | Source GPR; when the encoded register number is 0 the operand is the literal 64-bit zero, not r0. |
d |
lwz: read; lwzu: read | 16-bit signed displacement (d) added to the base address register. |
RD |
lwz: write; lwzu: write; lwzux: write; lwzx: write | Destination GPR. |
RA |
lwzu: read; lwzu: write; lwzux: read; lwzux: write | Source GPR (r0–r31). |
RB |
lwzux: read; lwzx: read | Source GPR. |
Register Effects
lwz
- Reads (always):
RA0,d - Reads (conditional): none
- Writes (always):
RD - Writes (conditional): none
lwzu
- Reads (always):
RA,d - Reads (conditional): none
- Writes (always):
RD,RA - Writes (conditional): none
lwzux
- Reads (always):
RA,RB - Reads (conditional): none
- Writes (always):
RD,RA - Writes (conditional): none
lwzx
- Reads (always):
RA0,RB - Reads (conditional): none
- Writes (always):
RD - Writes (conditional): none
Status-Register Effects
No condition-register or status-register effects.
Operation (pseudocode)
EA <- (RA|0) + EXTS(d)
RT <- ZEXT32_to_64(MEM(EA, 4))
C Translation Example
/* lwz RT, d(RA) */
uint64_t base = (insn.RA == 0) ? 0 : r[insn.RA];
uint32_t ea = (uint32_t)(base + (int64_t)(int16_t)insn.D);
r[insn.RT] = (uint64_t)mem_read_u32_be(ea); /* zero-extend */
Implementation References
lwz
- Canary XML:
tools/ppc-instructions.xml— search formnem="lwz" - Canary emitter:
src/xenia/cpu/ppc/ppc_emit_memory.cc:289 - Sylpheed opcode:
crates/sylpheed-ppc/src/opcode.rs:162 - Sylpheed decoder:
crates/sylpheed-ppc/src/decoder.rs:470
Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_lwz(PPCHIRBuilder& f, const InstrData& i) {
// if RA = 0 then
// b <- 0
// else
// b <- (RA)
// EA <- b + EXTS(D)
// RT <- i32.0 || MEM(EA, 4)
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));
Value* rt =
f.ZeroExtend(f.ByteSwap(f.LoadOffset(b, offset, INT32_TYPE)), INT64_TYPE);
f.StoreGPR(i.D.RT, rt);
return 0;
}
lwzu
- Canary XML:
tools/ppc-instructions.xml— search formnem="lwzu" - Canary emitter:
src/xenia/cpu/ppc/ppc_emit_memory.cc:310 - Sylpheed opcode:
crates/sylpheed-ppc/src/opcode.rs:163 - Sylpheed decoder:
crates/sylpheed-ppc/src/decoder.rs:471
Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_lwzu(PPCHIRBuilder& f, const InstrData& i) {
// EA <- (RA) + EXTS(D)
// RT <- i32.0 || MEM(EA, 4)
// RA <- EA
Value* ra = f.LoadGPR(i.D.RA);
Value* offset = f.LoadConstantInt64(XEEXTS16(i.D.DS));
Value* rt = f.ZeroExtend(f.ByteSwap(f.LoadOffset(ra, offset, INT32_TYPE)),
INT64_TYPE);
f.StoreGPR(i.D.RT, rt);
StoreEA(f, i.D.RA, f.Add(ra, offset));
return 0;
}
lwzux
- Canary XML:
tools/ppc-instructions.xml— search formnem="lwzux" - Canary emitter:
src/xenia/cpu/ppc/ppc_emit_memory.cc:323 - Sylpheed opcode:
crates/sylpheed-ppc/src/opcode.rs:164 - Sylpheed decoder:
crates/sylpheed-ppc/src/decoder.rs:881
Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_lwzux(PPCHIRBuilder& f, const InstrData& i) {
// EA <- (RA) + (RB)
// RT <- i32.0 || MEM(EA, 4)
// RA <- EA
Value* ea = CalculateEA(f, i.X.RA, i.X.RB);
Value* rt = f.ZeroExtend(f.ByteSwap(f.Load(ea, INT32_TYPE)), INT64_TYPE);
f.StoreGPR(i.X.RT, rt);
StoreEA(f, i.X.RA, ea);
return 0;
}
lwzx
- Canary XML:
tools/ppc-instructions.xml— search formnem="lwzx" - Canary emitter:
src/xenia/cpu/ppc/ppc_emit_memory.cc:334 - Sylpheed opcode:
crates/sylpheed-ppc/src/opcode.rs:165 - Sylpheed decoder:
crates/sylpheed-ppc/src/decoder.rs:871
Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_lwzx(PPCHIRBuilder& f, const InstrData& i) {
// if RA = 0 then
// b <- 0
// else
// b <- (RA)
// EA <- b + (RB)
// RT <- i32.0 || MEM(EA, 4)
Value* ea = CalculateEA_0(f, i.X.RA, i.X.RB);
Value* rt = f.ZeroExtend(f.ByteSwap(f.Load(ea, INT32_TYPE)), INT64_TYPE);
f.StoreGPR(i.X.RT, rt);
return 0;
}
Extended Pseudocode
; lwz — D-form plain
EA <- (RA|0) + EXTS(d)
RT <- 0x0000_0000 || MEM(EA, 4) ; zero-extend 32→64
; lwzu — D-form with update (base-register post-write)
EA <- (RA) + EXTS(d) ; RA ≠ 0 required
RT <- 0x0000_0000 || MEM(EA, 4)
RA <- EA
; lwzx — X-form indexed
EA <- (RA|0) + (RB)
RT <- 0x0000_0000 || MEM(EA, 4)
; lwzux — X-form indexed with update
EA <- (RA) + (RB) ; RA ≠ 0 required
RT <- 0x0000_0000 || MEM(EA, 4)
RA <- EA
Special Cases & Edge Conditions
- Big-endian memory. The Xenon reads memory big-endian. Translating to little-endian hosts requires a byte-swap on the 32-bit read (or calling a
mem_read_u32_behelper as in the C example). Matching byte-order helpers in xenia:mem.read_u32(...)already returns a host-nativeu32of the big-endian word. - Zero-extension to 64 bits. The result occupies the full 64-bit GPR; the high 32 bits are zero. This is semantically distinct from
lwa/lwax/lwaux, which sign-extend. Most Xbox 360 code useslwzfor unsigned word loads and for pointer loads (addresses are 32-bit and fit in the low half). RA0(non-update forms). Inlwzandlwzx, when the encodedRA = 0the base is the literal zero, notr0. This enables absolute-address loadslwz RT, 0x8000(0)and is heavily used to read from statically-linked data near the TOC base.- Update forms require
RA ≠ 0.lwzu/lwzuxinvoke "RA = 0" as an invalid form; AIX docs say the result is undefined and assemblers will refuse to assemblelwzu RT, d(0). Further,RA = RTis also invalid (the "effective address" write and the "loaded value" write would race). Xenia implements update forms without these checks; rely on incoming code being well-formed. - No alignment requirement. Xenon executes unaligned word loads without a fault (unlike some POWER cores).
MEM(EA, 4)reads four bytes starting atEA, whatever alignment. - No ordering guarantee. These are ordinary cached loads; use
sync/isync/lwsyncfor explicit ordering, orlwarxfor load-reserve semantics. - Indexed variant operand order.
lwzx RT, RA, RB—RAis the base (withRA0semantics),RBis the offset. The variant withoutRA0islwzux.
Related Instructions
lwa,lwax,lwaux— load word, sign-extend to 64.lwbrx— load word byte-reversed (little-endian word).lwarx— load word and reserve (pair withstwcx).ld,ldu,ldx,ldux— 64-bit loads.lhz,lbz— half-word / byte zero-extending loads (same family structure).stwfamily — the corresponding stores.