Files
Sylpheed/tools/ppc-manual/vmx/vcmpeqfp.md
sim f3c512f2ab docs(ppc-manual): check every xenia-rs claim against Canary's source
The hand-written parts of the manual still described how the retired
xenia-rs interpreter behaved: its snapshots, Rust casts and helpers. Each of
those 490 statements is now either restated as what Canary's emitters and
x64 backend actually do (at the pinned canary_experimental commit), or
dropped where it only made sense for xenia-rs.

Checking them turned up claims that were wrong, not just outdated:

- VSCR[SAT] is never modelled in Canary (DID_SATURATE is a stub and mfvscr
  cannot see it); the pages said saturating ops set it stickily.
- Canary does not implement lswi/lswx/stswi/stswx, dcbi, mtfsb0/mtfsb1,
  vmsum*, vmhaddshs, vupkhpx/vupklpx, and most SPRs; pages described them
  as working.
- Traps evaluate TO in Canary; stvebx/stvehx/stvewx store one element, not
  16 bytes; mtmsrd writes only EE; fres/frsqrte/vrsqrtefp precision claims
  and the stfs "rounds under RN / sets FPSCR" claim contradicted the spec.
- Reservations are a 64 KiB block bitmap plus a value compare, not
  per-address tracking.

Claims that neither Canary's source nor a public spec settles are marked
unverified (NI at boot, vmaddcfp128 operand order, estimate bit-exactness).

Generated regions are untouched; re-running the generator changes nothing.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-16 21:52:38 +02:00

8.0 KiB
Raw Permalink Blame History

vcmpeqfp — Vector Compare Equal-to Floating Point

Category: VMX (Altivec) · Form: VC · Opcode: 0x100000c6

Assembler Mnemonics

Mnemonic XML entry Flags Description
vcmpeqfp vcmpeqfp Vector Compare Equal-to Floating Point
vcmpeqfp. vcmpeqfp Rc=1 Vector Compare Equal-to Floating Point
vcmpeqfp128 vcmpeqfp128 Vector128 Compare Equal-to Floating Point
vcmpeqfp128. vcmpeqfp128 Rc=1 Vector128 Compare Equal-to Floating Point

Syntax

vcmpeqfp[Rc] [VD], [VA], [VB]
vcmpeqfp128[Rc] [VD], [VA], [VB]

Encoding

vcmpeqfp — form VC

  • Opcode word: 0x100000c6
  • Primary opcode (bits 05): 4
  • Extended opcode: 198
  • Synchronising: no
Bits Field Meaning
05 OPCD primary opcode (4)
610 VRT destination vector register
1115 VRA source A
1620 VRB source B
21 Rc record-form flag (updates CR6)
2231 XO extended opcode (10 bits)

vcmpeqfp128 — form VX128_R

  • Opcode word: 0x18000000
  • Primary opcode (bits 05): 6
  • Extended opcode: 0
  • Synchronising: no
Bits Field Meaning
05 OPCD primary opcode (4)
610 VD128l destination low 5 bits
1115 VA128l source A low 5 bits
1620 VB128l source B low 5 bits
21 VA128H source A high bit
2225 XO extended opcode (compare)
26 VA128h source A middle bit
27 Rc record-form flag (updates CR6)
2829 VD128h destination high 2 bits
3031 VB128h source B high 2 bits

Operands

Field Role Description
VA vcmpeqfp: read; vcmpeqfp128: read Source A vector register.
VB vcmpeqfp: read; vcmpeqfp128: read Source B vector register.
VD vcmpeqfp: write; vcmpeqfp128: write Destination vector register.
CR vcmpeqfp: write (conditional); vcmpeqfp128: 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

vcmpeqfp

  • Reads (always): VA, VB
  • Reads (conditional): none
  • Writes (always): VD
  • Writes (conditional): CR

vcmpeqfp128

  • Reads (always): VA, VB
  • Reads (conditional): none
  • Writes (always): VD
  • Writes (conditional): CR

Status-Register Effects

  • vcmpeqfp: CR6[all-true, 0, all-false, 0] when Rc=1.
  • vcmpeqfp128: CR6[all-true, 0, all-false, 0] when Rc=1.

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

vcmpeqfp

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_vcmpeqfp(PPCHIRBuilder& f, const InstrData& i) {
  return InstrEmit_vcmpxxfp_(f, i, vcmpxxfp_eq, i.VXR.VD, i.VXR.VA, i.VXR.VB,
                             i.VXR.Rc);
}

vcmpeqfp128

Canary emitter (frozen snapshot @ f21ebd49e9)
int InstrEmit_vcmpeqfp128(PPCHIRBuilder& f, const InstrData& i) {
  return InstrEmit_vcmpxxfp_(f, i, vcmpxxfp_eq, VX128_R_VD128, VX128_R_VA128,
                             VX128_R_VB128, i.VX128_R.Rc);
}

Special Cases & Edge Conditions

  • Per-lane mask: all-ones / all-zero. For each of the four word lanes, VD[i] = (VA[i] == VB[i]) ? 0xFFFFFFFF : 0. Lane 0 is the most-significant word.
  • NaN handling is IEEE-754: never equal. NaN == anything is false (including NaN == NaN), so the lane stays zero. This is the standard quiet-compare behaviour — no exception, no sticky flag.
  • Sign of zero ignored. +0 == -0 per IEEE-754, so the lane is set to all-ones.
  • VSCR[NJ] — denormals. With NJ = 1 (Xenon default), denormal inputs are flushed to ±0 before the comparison; ±denormal == ±0 then compares as true. This is one of the few VMX float ops where the NJ flag changes program-visible mask values.
  • CR6 update when Rc=1 (vcmpeqfp.). CR6 = [lt = all-true, gt = 0, eq = all-false, so = 0]; Canary's UpdateCR6 packs exactly that. Use bc 12,24 for "all-equal" branches and bc 4,26 for "any-equal".
  • Compose with vsel. Mask drives vsel to pick between two source vectors per lane. Or combine masks with vand / vor / vandc to express conjunctions.
  • No VSCR[SAT], no XER changes, no traps — even on signaling NaNs (Altivec's quiet-compare semantics).
  • VMX128 sibling (vcmpeqfp128). Identical semantics with the extended 128-register encoding; Canary routes both opcodes to one body (InstrEmit_vcmpxxfp_).

IBM Reference