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

# `vcmpequh` — Vector Compare Equal-to Unsigned Half Word

> **Category:** [VMX (Altivec)](../categories/vmx.md) · **Form:** [VC](../forms/VC.md) · **Opcode:** `0x10000046`

<!-- GENERATED: BEGIN -->

## Assembler Mnemonics

| Mnemonic | XML entry | Flags | Description |
| --- | --- | --- | --- |
| `vcmpequh` | `vcmpequh` | — | Vector Compare Equal-to Unsigned Half Word |
| `vcmpequh.` | `vcmpequh` | Rc=1 | Vector Compare Equal-to Unsigned Half Word |

## Syntax

```asm
vcmpequh[Rc] [VD], [VA], [VB]
```

## Encoding

### `vcmpequh` — form `VC`

- **Opcode word:** `0x10000046`
- **Primary opcode (bits 0–5):** `4`
- **Extended opcode:** `70`
- **Synchronising:** no

| Bits | Field | Meaning |
| --- | --- | --- |
| 0–5 | `OPCD` | primary opcode (4) |
| 6–10 | `VRT` | destination vector register |
| 11–15 | `VRA` | source A |
| 16–20 | `VRB` | source B |
| 21 | `Rc` | record-form flag (updates CR6) |
| 22–31 | `XO` | extended opcode (10 bits) |

## Operands

| Field | Role | Description |
| --- | --- | --- |
| `VA` | vcmpequh: read | Source A vector register. |
| `VB` | vcmpequh: read | Source B vector register. |
| `VD` | vcmpequh: write | Destination vector register. |
| `CR` | vcmpequh: 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

### `vcmpequh`

- **Reads (always):** `VA`, `VB`
- **Reads (conditional):** _none_
- **Writes (always):** `VD`
- **Writes (conditional):** `CR`

## Status-Register Effects

- `vcmpequh`: **CR6** ← `[all-true, 0, all-false, 0]` when `Rc=1`.

## 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
/* 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

**`vcmpequh`**
- xenia-canary XML: [`tools/ppc-instructions.xml` — search for `mnem="vcmpequh"`](../../xenia-canary/tools/ppc-instructions.xml)
- xenia-canary emit: [`src/xenia/cpu/ppc/ppc_emit_altivec.cc:723`](../../xenia-canary/src/xenia/cpu/ppc/ppc_emit_altivec.cc#L723)
- xenia-rs opcode: [`crates/xenia-cpu/src/opcode.rs:95`](../../xenia-rs/crates/xenia-cpu/src/opcode.rs#L95)
- xenia-rs decoder: [`crates/xenia-cpu/src/decoder.rs:558`](../../xenia-rs/crates/xenia-cpu/src/decoder.rs#L558)
- xenia-rs interpreter: [`crates/xenia-cpu/src/interpreter.rs:3736-3748`](../../xenia-rs/crates/xenia-cpu/src/interpreter.rs#L3736-L3748)
<details><summary>xenia-rs interpreter body (frozen snapshot)</summary>

```rust
        PpcOpcode::vcmpequh => {
            let a = ctx.vr[instr.ra()].as_u16x8();
            let b = ctx.vr[instr.rb()].as_u16x8();
            let mut r = [0u16; 8];
            for i in 0..8 { r[i] = if a[i] == b[i] { 0xFFFF } else { 0 }; }
            let v = xenia_types::Vec128::from_u16x8_array(r);
            if instr.vc_rc_bit() {
                let (t, f) = crate::vmx::cr6_flags_from_mask(v);
                ctx.cr[6] = crate::context::CrField { lt: t, gt: false, eq: f, so: false };
            }
            ctx.vr[instr.rd()] = v;
            ctx.pc += 4;
        }
```
</details>

<!-- GENERATED: END -->

## Special Cases & Edge Conditions

- **Per-half mask: all-ones / all-zero.** Eight half-word lanes; `VD[i] = (VA[i] == VB[i]) ? 0xFFFF : 0x0000`. Lane 0 (`VD[0..1]` after `stvx`) is the most-significant half.
- **Sign-agnostic.** Equality is bit-identical for signed and unsigned halves; there is no `vcmpeqsh`.
- **CR6 update when `Rc=1`** (`vcmpequh.`). CR6 = `[lt = all-true, gt = 0, eq = all-false, so = 0]`. Use `bc 12,24` for "all-equal" branches and `bc 12,26` for "no-equal".
- **Compose with `vsel`.** Mask drives [`vsel`](vsel.md) per half-word.
- **Common usage.** UTF-16 character classification, audio-sample needle search, indexed-mesh deduplication.
- **No `VSCR` interaction, no XER, no traps.**
- **Aliasing legal.**
- **No VMX128 sibling.**

## Related Instructions

- [`vcmpequb`](vcmpequb.md), [`vcmpequw`](vcmpequw.md) — equality compare at byte / word width.
- [`vcmpgtuh`](vcmpgtuh.md), [`vcmpgtsh`](vcmpgtsh.md) — `>` at half width, unsigned / signed.
- [`vsel`](vsel.md), [`vand`](vand.md), [`vandc`](vandc.md), [`vor`](vor.md), [`vxor`](vxor.md) — mask consumers / combinators.
- [`vspltish`](vspltish.md), [`vsplth`](vsplth.md) — broadcast sources for needle patterns.

## IBM Reference

- [AIX 7.3 — `vcmpequh` (Vector Compare Equal-to Unsigned Half Word)](https://www.ibm.com/docs/en/aix/7.3.0?topic=set-vcmpequh-vector-compare-equal-unsigned-half-word-instruction)
- [IBM AltiVec Technology Programmer's Interface Manual, Chapter 6 — Vector Compares](https://www.nxp.com/docs/en/reference-manual/ALTIVECPIM.pdf)