Files
Sylpheed/tools/ppc-manual/alu/cmp.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

6.3 KiB
Raw Blame History

cmp — Compare

Category: Integer ALU · Form: X · Opcode: 0x7c000000

Assembler Mnemonics

Mnemonic XML entry Flags Description
cmp cmp Compare

Syntax

cmp [CRFD], [L], [RA], [RB]

Encoding

cmp — form X

  • Opcode word: 0x7c000000
  • Primary opcode (bits 05): 31
  • Extended opcode: 0
  • Synchronising: no
Bits Field Meaning
05 OPCD primary opcode
610 RT/FRT/VRT destination
1115 RA/FRA/VRA source A
1620 RB/FRB/VRB source B
2130 XO extended opcode (10 bits)
31 Rc record-form flag

Operands

Field Role Description
L cmp: read Operand-length bit for compare instructions (0 ⇒ 32-bit, 1 ⇒ 64-bit).
RA cmp: read Source GPR (r0r31).
RB cmp: read Source GPR.
CRFD cmp: write CR destination field (crf, 07).

Register Effects

cmp

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

Status-Register Effects

No condition-register or status-register effects.

Operation (pseudocode)

if L = 0 then a,b <- EXTS((RA)[32:63]), EXTS((RB)[32:63])
else             a,b <- (RA), (RB)
CR[BF] <- signed_compare(a, b) || XER[SO]

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

cmp

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_cmp(PPCHIRBuilder& f, const InstrData& i) {
  // if L = 0 then
  //   a <- EXTS((RA)[32:63])
  //   b <- EXTS((RB)[32:63])
  // else
  //   a <- (RA)
  //   b <- (RB)
  // if a < b then
  //   c <- 0b100
  // else if a > b then
  //   c <- 0b010
  // else
  //   c <- 0b001
  // CR[4×BF+32:4×BF+35] <- c || XER[SO]
  uint32_t BF = i.X.RT >> 2;
  uint32_t L = i.X.RT & 1;
  Value* lhs;
  Value* rhs;
  if (L) {
    lhs = f.LoadGPR(i.X.RA);
    rhs = f.LoadGPR(i.X.RB);
  } else {
    lhs = f.Truncate(f.LoadGPR(i.X.RA), INT32_TYPE);
    rhs = f.Truncate(f.LoadGPR(i.X.RB), INT32_TYPE);
  }
  f.UpdateCR(BF, lhs, rhs);
  return 0;
}

Extended Pseudocode

if L = 0 then                                   ; 32-bit compare
    a <- EXTS((RA)[32:63])                      ; sign-extend low word to 64
    b <- EXTS((RB)[32:63])
else                                            ; 64-bit compare
    a <- (RA)
    b <- (RB)
CR[BF] <- { LT: a <s b, GT: a >s b, EQ: a = b, SO: XER[SO] }   ; signed

Special Cases & Edge Conditions

  • BF is a CR field (07), not a bit. The crfD operand encodes which of the eight 4-bit CR fields is updated. Assemblers write it as crN where N ∈ 0..7. The simplified mnemonic cmpw RA, RBcmp cr0, 0, RA, RB is universal in Xbox 360 code.
  • L bit selects width. L = 0 (the usual cmpw / cmpd-is-rare path) performs a 32-bit signed compare of RA[32:63] and RB[32:63], both sign-extended to 64 bits. L = 1 (cmpd) performs a full 64-bit signed compare.
  • Signed. Use cmpl / cmpli for unsigned comparisons. Confusing signed/unsigned is the most common compare-family bug in hand-written asm.
  • SO is always copied from XER[SO]. This makes overflow observable across arithmetic/compare sequences: an addo. followed by beq can branch on the record-form flag while bso can inspect the sticky overflow.
  • cr0 is the default for record-form ALU; by convention assemblers and generators reserve cr0 for the chain of Rc=1 instructions and use cr1..cr7 (or cmp to an explicit field) for standalone compares. Don't assume cmp writes cr0 unless the BF operand says so.
  • No register is written beyond the 4-bit CR field. cmp has no Rc or OE bit.
  • Xenia-rs quirk. The interpreter recomputes EQ after the signed compare to guard against a subtract-cancellation edge case; this is a defensive belt-and-braces against the 32-bit narrowing path. Functionally equivalent to the spec.
  • cmpi — signed compare against a 16-bit immediate.
  • cmpl, cmpli — unsigned versions.
  • cmpw, cmpd — simplified mnemonics selecting L.
  • mcrxr — move XER[SO..CA] into a CR field and clear them; used to reset sticky overflow.
  • Every Rc=1 ALU instruction (addx, subfx, andx, …) — these implicitly perform a signed-compare-to-zero into cr0; use explicit cmp only when comparing two non-zero values or using a non-zero CR field.

IBM Reference