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

5.1 KiB
Raw Blame History

cntlzwx — Count Leading Zeros Word

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

Assembler Mnemonics

Mnemonic XML entry Flags Description
cntlzw cntlzwx Count Leading Zeros Word
cntlzw. cntlzwx Rc=1 Count Leading Zeros Word

Syntax

cntlzw[Rc] [RA], [RS]

Encoding

cntlzwx — form X

  • Opcode word: 0x7c000034
  • Primary opcode (bits 05): 31
  • Extended opcode: 26
  • 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
RS cntlzwx: read Source GPR (alias for RD in some stores).
RA cntlzwx: write Source GPR (r0r31).
CR cntlzwx: write (conditional) Condition-register update. When Rc=1, CR field 0 (or CR6 for vector compares, CR1 for FPU) is updated from the result.

Register Effects

cntlzwx

  • Reads (always): RS
  • Reads (conditional): none
  • Writes (always): RA
  • Writes (conditional): CR

Status-Register Effects

  • cntlzwx: CR0 ← signed-compare(result, 0) with SO ← XER[SO], when Rc=1.

Operation (pseudocode)

n <- number_of_leading_zero_bits((RS)[32:63])    ; n in 0..32
RA <- zero_extend(n)

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

cntlzwx

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_cntlzwx(PPCHIRBuilder& f, const InstrData& i) {
  // n <- 32
  // do while n < 64
  //   if (RS)[n] = 1 then leave n
  //   n <- n + 1
  // RA <- n - 32
  Value* v = f.CountLeadingZeros(f.Truncate(f.LoadGPR(i.X.RT), INT32_TYPE));
  v = f.ZeroExtend(v, INT64_TYPE);
  f.StoreGPR(i.X.RA, v);
  if (i.X.Rc) {
    f.UpdateCR(0, v);
  }
  return 0;
}

Special Cases & Edge Conditions

  • Operates only on the low 32 bits. RS[0:31] is ignored; the count is taken on RS[32:63]. Result range is 0..=32.
  • RA = 32 when the low 32 bits are zero, regardless of the high 32 bits. A common pitfall: cntlzw after computing a 64-bit value can give a counter-intuitive result when the leading 1-bit lives in the high half.
  • RA = 0 when bit 32 (the sign bit of the low word) is set. This makes cntlzw RA, RS; cmpwi RA, 0 a one-instruction-pair "is the low half negative" test, though srawi RA, RS, 31 is more idiomatic.
  • High 32 bits of the result are zero. RA[0:31] = 0, RA[32:63] = count.
  • Rc=1 CR0 update is small-positive-only. Result fits in 6 bits; xenia's as i32 as i64 truncation in interpreter.rs:404 is harmless. CR0 will be EQ only when RS[32] (sign bit of low word) is 1, otherwise GT.
  • Useful for floor(log2) of a 32-bit value. 31 - cntlzw(x) for nonzero x.
  • cntlzdx — 64-bit version (counts the full register).
  • slwx, srwx, srawx — 32-bit shifts often paired with cntlzw for normalisation.
  • rlwinmx — to mask off bits before counting.
  • cmpi, cmpl — alternative ways to detect zero or sign.

IBM Reference