xenia-rs/migration/project-root/ppc-manual/vmx/vavgub.md

vavgub — Vector Average Unsigned Byte

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

Assembler Mnemonics

Mnemonic	XML entry	Flags	Description
vavgub	vavgub	—	Vector Average Unsigned Byte

Syntax

vavgub [VD], [VA], [VB]

Encoding

vavgub — form VX

• Opcode word: 0x10000402
• Primary opcode (bits 0–5): 4
• Extended opcode: 1026
• 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
VA	vavgub: read	Source A vector register.
VB	vavgub: read	Source B vector register.
VD	vavgub: write	Destination vector register.

Register Effects

vavgub

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

Status-Register Effects

No condition-register or status-register effects.

Operation (pseudocode)

; Pseudocode derives directly from the xenia-rs interpreter
; arm (see Implementation References). Operation semantics:
;   - Read source operands from the fields listed under Operands.
;   - Apply the arithmetic / logical / memory action described
;     in the Description field above.
;   - Write results to the destination register(s); update any
;     status bits enumerated under Status-Register Effects.
; Consult the IBM AIX reference link under IBM Reference for
; canonical PPC-style pseudocode where xenia's expression is
; terse.

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

vavgub

• xenia-canary XML: tools/ppc-instructions.xml — search for mnem="vavgub"
• xenia-canary emit: src/xenia/cpu/ppc/ppc_emit_altivec.cc:468
• xenia-rs opcode: crates/xenia-cpu/src/opcode.rs:92
• xenia-rs decoder: crates/xenia-cpu/src/decoder.rs:520
• xenia-rs interpreter: crates/xenia-cpu/src/interpreter.rs:3402-3409

xenia-rs interpreter body (frozen snapshot)

        PpcOpcode::vavgub => {
            let a = ctx.vr[instr.ra()].as_bytes();
            let b = ctx.vr[instr.rb()].as_bytes();
            let mut r = [0u8; 16];
            for i in 0..16 { r[i] = crate::vmx::avg_u8(a[i], b[i]); }
            ctx.vr[instr.rd()] = xenia_types::Vec128::from_bytes(r);
            ctx.pc += 4;
        }

Special Cases & Edge Conditions

• Sixteen unsigned-byte rounding averages. Each VD[i] = (VA[i] + VB[i] + 1) >> 1, computed in 16-bit arithmetic so the +1 cannot overflow, then truncated back to u8. Rounding is half-up.
• Big-endian byte lanes. Lane 0 is the most-significant byte after stvx.
• No VSCR[SAT] impact. The result always fits in u8 (the average of two u8 values is at most 255). Xenia uses crate::vmx::avg_u8 (crates/xenia-cpu/src/vmx.rs).
• Equivalent to _mm_avg_epu8 on x86 SSE2 — semantically identical (rounding mode and width match).
• Common usage. Pixel-blend (A + B + 1) / 2, MPEG/H.264 half-pel motion-compensation averaging, downscale filters, alpha midpoint.
• Aliasing legal. vavgub v3, v3, v4.
• No VMX128 sibling.

Related Instructions

• vavgsb — same width, signed rounding average.
• vavguh, vavguw — unsigned rounding average at half / word width.
• vaddubm, vaddubs — addition variants without the divide step.
• vsububm — modulo subtract; difference before averaging.

IBM Reference

• AIX 7.3 — vavgub (Vector Average Unsigned Byte)
• IBM AltiVec Technology Programmer's Interface Manual, Chapter 6 — Average Instructions