CONSOLIDATION.md Phase 6. Both lived untracked in the project root -- on one
disk, backed up by nothing.
tools/ppc-manual/ 393 files, 3.7 MB. 455 instructions, 350 family pages,
598 mnemonics resolvable through index.json, plus the
generator that produced them.
tools/run-canary.sh the oracle launcher.
🔴 THE LAUNCHER WAS BROKEN IN TWO WAYS AND IS REWRITTEN, not copied:
* it pointed at `xenia-rs/sylpheed.iso`, a SYMLINK. Wine cannot resolve one
and says "path invalid", which reads as a corrupt image rather than a path
problem -- it has cost a session before. It now points at the real file and
warns if handed a symlink.
* it hardcoded one machine's absolute paths, and named `xenia-rs`, which this
consolidation retires. Now derived from the script's own location, with
SYLPH_CANARY_BIN / SYLPH_ISO overrides and a check that each exists.
The standing constraints are in its header where someone will read them: one
emulator at a time, Canary runs MUTED, and never judge a crash or a hang from
a Bash-launched run -- a SIGKILL that looked like the binary was the editor's
process supervisor.
⚠️ The manual's GENERATOR reads the xenia-rs source tree, which is going away.
Its decoder now lives here as crates/sylpheed-ppc, so the generator must be
repointed before it is run again. Recorded in the README rather than left for
someone to discover; the manual's content is checked in and regenerates from
nothing implicitly.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
7.3 KiB
bcctrx — Branch Conditional to Count Register
Category: Branch & System · Form: XL · Opcode:
0x4c000420· sync
Assembler Mnemonics
| Mnemonic | XML entry | Flags | Description |
|---|---|---|---|
bcctr |
bcctrx |
— | Branch Conditional to Count Register |
bcctrl |
bcctrx |
LK=1 | Branch Conditional to Count Register |
Syntax
bcctr[LK] [BO], [BI]
Encoding
bcctrx — form XL
- Opcode word:
0x4c000420 - Primary opcode (bits 0–5):
19 - Extended opcode:
528 - Synchronising: yes
| Bits | Field | Meaning |
|---|---|---|
| 0–5 | OPCD |
primary opcode (19) |
| 6–10 | BT/BO |
target / branch options |
| 11–15 | BA/BI |
source A / CR bit to test |
| 16–20 | BB |
source B |
| 21–30 | XO |
extended opcode (10 bits) |
| 31 | LK |
link flag |
Operands
| Field | Role | Description |
|---|---|---|
LK |
bcctrx: read | Link bit. When 1, LR ← address-of-next-instruction before the branch is taken. |
BO |
bcctrx: read | 5-bit branch options — selects CTR decrement, CTR test polarity, and CR bit test polarity. See forms/XL.md. |
BI |
bcctrx: read | CR bit index (0–31) selected by BO's condition test. |
CR |
bcctrx: read | Condition-register update. When Rc=1, CR field 0 (or CR6 for vector compares, CR1 for FPU) is updated from the result. |
CTR |
bcctrx: read | Count register. Decremented and optionally tested by conditional branches when BO[2]=0. |
LR |
bcctrx: write (conditional) | Link register. Written by bl/bla/bcl/bclrl/bcctrl; read by bclr/bclrl. |
Register Effects
bcctrx
- Reads (always):
LK,BO,BI,CR,CTR - Reads (conditional): none
- Writes (always): none
- Writes (conditional):
LR
Status-Register Effects
No condition-register or status-register effects.
Operation (pseudocode)
cond_ok <- BO[0] | (CR[BI] ≡ BO[1])
if cond_ok then NIA <- CTR[0:61] || 0b00
if LK then LR <- CIA + 4
C Translation Example
/* C translation: the xenia-rs interpreter arm below in */
/* Implementation References is the authoritative semantic */
/* snapshot. Translate it line-by-line: */
/* - ctx.gpr[N] -> r[N] (or f[]/v[] for FPRs/VRs) */
/* - mem.read_u*/write_u* -> mem_read_u*_be / mem_write_u*_be */
/* - ctx.update_cr_signed(fld, v) -> update_cr_signed(fld, v) */
/* - ctx.xer_ca / xer_ov / xer_so -> xer.CA / xer.OV / xer.SO */
/* The Register Effects and Status-Register Effects tables above */
/* enumerate every side effect a faithful translation must emit. */
Implementation References
bcctrx
- xenia-canary XML:
tools/ppc-instructions.xml— search formnem="bcctrx" - xenia-canary emit:
src/xenia/cpu/ppc/ppc_emit_control.cc:250 - xenia-rs opcode:
crates/xenia-cpu/src/opcode.rs:11 - xenia-rs decoder:
crates/xenia-cpu/src/decoder.rs:721 - xenia-rs interpreter:
crates/xenia-cpu/src/interpreter.rs:962-981
xenia-rs interpreter body (frozen snapshot)
PpcOpcode::bcctrx => {
let bo = instr.bo();
let bi = instr.bi();
let cond_ok = (bo & 0b10000) != 0
|| (ctx.get_cr_bit(bi) == ((bo & 0b01000) != 0));
if cond_ok {
let next_pc = ctx.pc + 4;
ctx.pc = (ctx.ctr as u32) & !3;
if instr.lk() {
ctx.lr = next_pc as u64;
}
} else {
if instr.lk() {
ctx.lr = (ctx.pc + 4) as u64;
}
ctx.pc += 4;
}
}
Special Cases & Edge Conditions
-
No CTR decrement. Unlike
bcxandbclrx,bcctrcannot decrement CTR (the CTR is the target). The PowerISA reservesBO[2] = 0encodings — they are invalid onbcctrx. xenia silently ignoresBO[2]/BO[3]and treats everybcctras a pure CR-conditional branch, which matches both the canary emit and real Xenon hardware behaviour. -
CTR alignment mask. The target is
CTR & ~3. Likebclr, the low two bits are stripped — a misaligned CTR is silently rounded down rather than trapping. -
BO encoding (CR-only subset). Because CTR-test bits are unused, only four
BOpatterns are meaningful:BO (binary) Meaning 0100zbranch if CR[BI]false0101zbranch if CR[BI]true1z1zzbranch always ( bctr)0000z/001at/etc.reserved — implementation-defined -
Indirect call/dispatch idiom.
mtctr rN; bctrlis the canonical PPC indirect call: load function pointer into CTR, call. The xenia interpreter writesLR ← CIA + 4only when the branch is taken — this matches the PowerISA, but contrast withbcxwhereLKalways writes LR (even if the branch is not taken). The C-translation reference handles this asymmetry explicitly. -
bctrfor switch tables. Compilers emitbctr(notbctrl) for jump-table dispatch, with CTR loaded from a base + (index*4) lookup. Xenia honours this by simply jumping toCTR & ~3. -
Synchronisation. Marked
syncin xenia's XML — context-synchronising. JIT backends must ensure prior side effects have committed before the indirect transfer. -
No prediction hint sensitivity. Xenon predicts indirect branches via a separate target cache; the
BO[4]hint is mostly cosmetic forbcctr.
Related Instructions
bclrx— branch conditional to LR (function returns).bcx— branch conditional to displacement (B-form).bx— unconditional displacement branch (I-form).mtctr,mfctr— load/read CTR viamtspr 9/mfspr 9.sc— alternative control-flow exit (system call).
Simplified Mnemonics
| Simplified | Expansion |
|---|---|
bctr |
bcctr BO=0b10100, BI=0 — unconditional indirect branch |
bctrl |
bcctrl BO=0b10100, BI=0 — unconditional indirect call |
beqctr crN |
bcctr BO=0b01100, BI=4·N+2 — call CTR if crN.EQ |
bnectr crN |
bcctr BO=0b00100, BI=4·N+2 — call CTR if crN.NE |
bltctr crN |
bcctr BO=0b01100, BI=4·N+0 — call CTR if crN.LT |
bgectr crN |
bcctr BO=0b00100, BI=4·N+0 — call CTR if crN.GE |
bgtctr crN |
bcctr BO=0b01100, BI=4·N+1 — call CTR if crN.GT |
blectr crN |
bcctr BO=0b00100, BI=4·N+1 — call CTR if crN.LE |
The unconditional bctr/bctrl are by far the most common in Xbox 360 disassembly (compiler-emitted indirect calls and switch dispatch).