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.8 KiB
5.8 KiB
dcbf — Data Cache Block Flush
Assembler Mnemonics
| Mnemonic | XML entry | Flags | Description |
|---|---|---|---|
dcbf |
dcbf |
— | Data Cache Block Flush |
Syntax
dcbf [RA0], [RB]
Encoding
dcbf — form X
- Opcode word:
0x7c0000ac - Primary opcode (bits 0–5):
31 - Extended opcode:
86 - 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 |
dcbf: read | Source GPR; when the encoded register number is 0 the operand is the literal 64-bit zero, not r0. |
RB |
dcbf: read | Source GPR. |
Register Effects
dcbf
- Reads (always):
RA0,RB - Reads (conditional): none
- Writes (always): none
- 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
dcbf
- Canary XML:
tools/ppc-instructions.xml— search formnem="dcbf" - Canary emitter:
src/xenia/cpu/ppc/ppc_emit_memory.cc:1125 - Sylpheed opcode:
crates/sylpheed-ppc/src/opcode.rs:44 - Sylpheed decoder:
crates/sylpheed-ppc/src/decoder.rs:888
Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_dcbf(PPCHIRBuilder& f, const InstrData& i) {
if (!cvars::disable_prefetch_and_cachecontrol) {
Value* ea = CalculateEA_0(f, i.X.RA, i.X.RB);
f.CacheControl(ea, 128,
CacheControlType::CACHE_CONTROL_TYPE_DATA_STORE_AND_FLUSH);
}
return 0;
}
Special Cases & Edge Conditions
- Flush = write-back + invalidate. If the addressed line is dirty in the data cache, it is written to memory; whether dirty or clean, the line is then removed from the cache. Subsequent loads must refill from memory.
- Cache line size. Xenon's L1/L2 lines are 128 bytes. The hardware ignores the low seven bits of
EA, sodcbf RA, RBflushes the line containingEAregardless of where in that lineEAlies. There is nodcbf128variant — the hint is sized to the architectural line. RA0semantics. WhenRA = 0, the base is the literal zero —dcbf 0, RBflushes the line containing addressRB. The instruction has no destination register.- Xenia models a no-op. Xenia-rs's emulator does not maintain a coherent cache model; the decode entry exists but the interpreter typically advances PC without further effect, since target memory is always coherent on the host. This is correct behaviour for an emulator.
- Unprivileged.
dcbfis a problem-state instruction — usable from user code. Storage protection still applies; flushing an unmapped page raises a DSI exception. - Pair with
sync. Hardwaredcbfdoes not by itself impose ordering; software that needs the flushed data visible to other masters (DMA, GPU) issues asyncafterwards. - Self-modifying code companion. When patching code, the recipe is
dcbst(push dirty data through to memory) →sync→icbi(invalidate I-cache) →isync.dcbfis the heavier alternative when the writer also wants the line out of D-cache.
Related Instructions
dcbst— write-back without invalidate (lighter thandcbf).dcbi— invalidate without write-back (privileged; loses dirty data).dcbt,dcbtst— touch hints to bring lines in.dcbz,dcbz128— allocate-and-zero a line.icbi— instruction-cache invalidate, used together for self-modifying code.sync— full memory barrier, typically followsdcbf.
IBM Reference
- AIX 7.3 —
dcbf(Data Cache Block Flush) PowerISA v2.07B Book II§ "Storage Control Instructions" for cache-coherence semantics.