Sylpheed/tools/ppc-manual/vmx/vctuxs.md

vctuxs — Vector Convert to Unsigned Fixed-Point Word Saturate

Category: VMX (Altivec) · Form: VX · Opcode: 0x1000038a

Assembler Mnemonics

Mnemonic	XML entry	Flags	Description
vctuxs	vctuxs	—	Vector Convert to Unsigned Fixed-Point Word Saturate

Syntax

vctuxs [VD], [VB], [UIMM]

Encoding

vctuxs — form VX

• Opcode word: 0x1000038a
• Primary opcode (bits 0–5): 4
• Extended opcode: 906
• Synchronising: no

Bits	Field	Meaning
0–5	OPCD	primary opcode (4)
6–10	VRT/VD	destination vector register
11–15	VRA/VA	source A vector register
16–20	VRB/VB	source B vector register
21–31	XO	extended opcode (11 bits)

Operands

Field	Role	Description
VB	vctuxs: read	Source B vector register.
UIMM	vctuxs: read	16-bit unsigned immediate. Zero-extended.
VD	vctuxs: write	Destination vector register.
VSCR	vctuxs: write	Vector Status and Control Register (NJ/SAT bits).

Register Effects

vctuxs

• Reads (always): VB, UIMM
• Reads (conditional): none
• Writes (always): VD, VSCR
• Writes (conditional): none

Status-Register Effects

• vctuxs: VSCR[SAT] may be stickied on saturating vector operations.

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

vctuxs

• Canary XML: tools/ppc-instructions.xml — search for mnem="vctuxs"
• Canary emitter: src/xenia/cpu/ppc/ppc_emit_altivec.cc:554
• Sylpheed opcode: crates/sylpheed-ppc/src/opcode.rs:341
• Sylpheed decoder: crates/sylpheed-ppc/src/decoder.rs:630

Canary emitter (frozen snapshot @ f21ebd49e9)

int InstrEmit_vctuxs(PPCHIRBuilder& f, const InstrData& i) {
  return InstrEmit_vctuxs_(f, i.VX.VD, i.VX.VB, i.VX.VA);
}

// ── delegates to (src/xenia/cpu/ppc/ppc_emit_altivec.cc:543) ──
int InstrEmit_vctuxs_(PPCHIRBuilder& f, uint32_t vd, uint32_t vb,
                      uint32_t uimm) {
  // (VD) <- int_sat(VB as unsigned * 2^uimm)
  float fuimm = static_cast<float>(std::exp2(uimm));
  Value* v =
      f.Mul(f.LoadVR(vb), f.Splat(f.LoadConstantFloat32(fuimm), VEC128_TYPE));
  v = f.VectorConvertF2I(v, ARITHMETIC_UNSIGNED);
  f.StoreSAT(f.DidSaturate(v));
  f.StoreVR(vd, v);
  return 0;
}

Special Cases & Edge Conditions

• Convert IEEE float lane to unsigned-Q uint32, saturating. For each of the four word lanes, VD[i] = clamp(round_toward_zero(VB[i] * 2^UIMM), 0, UINT32_MAX). The 5-bit UIMM (bits 11..15) gives the Q-format fractional shift, in 0..31.
• Saturating, not wrapping. Negative inputs clamp to 0; values above 2^32 − 1 clamp to 0xFFFF_FFFF. NaN → 0. All clamping events sticky-set VSCR[SAT] on hardware. Canary reproduces the values — vmaxps against zero (which also turns NaN into 0), a rebase for lanes ≥ 2^31, and an all-ones fix-up for overflow (or vcvttps2udq with a mask on AVX-512 hosts) — but never records SAT.
• VSCR[SAT] sticky. Cleared only by mtvscr.
• Rounding is truncate-toward-zero. Always.
• VSCR[NJ] flushes denormal inputs to zero before scaling (Xenon default).
• Big-endian word lanes. Lane 0 is the most-significant word.
• No XER changes, no traps.
• No VMX128 sibling.
• Common usage. Float colour [0.0, 1.0] → packed 0..2^N−1 integer with vctuxs vD, vColor, 8 (Q24.8 → 0..255 after a vpkshus) or , 32 for full unsigned-int range.

Related Instructions

• vctsxs — same shape, signed destination.
• vcfsx, vcfux — inverse direction.
• vrfin, vrfip, vrfim, vrfiz — float-to-float rounding modes.
• mtvscr / mfvscr — read or clear VSCR[SAT].

IBM Reference

• AIX 7.3 — vctuxs (Vector Convert to Unsigned Fixed-Point Word Saturate)
• IBM AltiVec Technology Programmer's Interface Manual, Chapter 5 — Conversion Instructions