Files
Sylpheed/tools/ppc-manual/control/mcrf.md
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.4 KiB
Raw Blame History

mcrf — Move Condition Register Field

Category: Control / CR / SPR · Form: XL · Opcode: 0x4c000000

Assembler Mnemonics

Mnemonic XML entry Flags Description
mcrf mcrf Move Condition Register Field

Syntax

mcrf [CRFD], [CRFS]

Encoding

mcrf — form XL

  • Opcode word: 0x4c000000
  • Primary opcode (bits 05): 19
  • Extended opcode: 0
  • Synchronising: no
Bits Field Meaning
05 OPCD primary opcode (19)
610 BT/BO target / branch options
1115 BA/BI source A / CR bit to test
1620 BB source B
2130 XO extended opcode (10 bits)
31 LK link flag

Operands

Field Role Description
CRFS mcrf: read CR source field.
CRFD mcrf: write CR destination field (crf, 07).

Register Effects

mcrf

  • Reads (always): CRFS
  • Reads (conditional): none
  • Writes (always): CRFD
  • 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

mcrf

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_mcrf(PPCHIRBuilder& f, const InstrData& i) {
  // CR[4*bf:4*bf+3] <- CR[4*bfa:4*bfa+3]   bf=bo, bfa=bi
  // LoadCR/StoreCR bake the field position into the word and cannot cross it.
  uint32_t crfd = i.XL.BO >> 2;
  uint32_t crfs = i.XL.BI >> 2;
  for (uint32_t bit = 0; bit < 4; ++bit) {
    f.StoreCRField(crfd, bit, f.LoadCRField(crfs, bit));
  }
  return 0;
}

Special Cases & Edge Conditions

  • Field-level (4-bit) move. Unlike the bit-level CR-logical family (crand, …, crxor), mcrf copies all four bits of a CR field (LT, GT, EQ, SO) in one instruction. CRFD and CRFS are 3-bit field indices (0..7), each naming a 4-bit slice of the 32-bit CR.
  • No source-field clobber. The source field is read, not modified — mcrf 0, 1 copies CR1 into CR0 leaving CR1 intact.
  • Same-field is a NOP. mcrf cr0, cr0 reads-then-writes the same field; xenia's interpreter still does the assignment but the architectural state is unchanged.
  • Use case. Promote a non-default compare result into cr0 so a default-cr0 simplified branch (beq label) can consume it without spelling out cr1/cr2/etc. The alternative — crmove — would require four cror instructions to move all four bits.
  • No CR0/XER side effects. Pure CR-field dataflow.
  • Not synchronising. Reorderable.
  • xenia exact match. xenia-rs models the CR as an array of eight 4-bit fields, so mcrf is a single struct copy (ctx.cr[crfd] = ctx.cr[crfs]). Matches PowerISA semantics exactly.
  • mfcr — read the entire 32-bit CR into a GPR.
  • mtcrf — write selected CR fields from a GPR (uses an 8-bit field-mask).
  • mcrxr — copy XER[SO..CA] into a CR field and clear them.
  • mcrfs — copy an FPSCR field into a CR field.
  • crand, crandc, creqv, crnand, crnor, cror, crorc, crxor — bit-level alternatives.
  • bcx — typical consumer.

mcrf has no simplified mnemonics.

IBM Reference