21161154d1
- Category pages linked each family as `<slug>.md`, relative to categories/, where no family page lives. They now link `../<category>/<slug>.md`. - Form pages linked a member into its *own* category directory, so every VMX128 sibling (`vsldoi128`) pointed at vmx128/ although its family page is under vmx/. They now link into the family's directory. - Hand-written "Related" and sibling mentions linked other categories' pages as if they were in the same directory. 109 are retargeted through the page index; 29 that pointed a family page at itself (`vrefp128` on vrefp.md) and 6 naming instructions the manual has no page for are plain text now. Regenerated at the existing Canary pin (f21ebd49e): upstream has moved on, and re-pinning belongs in its own change. The generator reports 0 family pages changed and is idempotent; the only dead links left are TEMPLATE.md's placeholders. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
178 lines
6.6 KiB
Markdown
178 lines
6.6 KiB
Markdown
# `vrfin` — Vector Round to Floating-Point Integer Nearest
|
||
|
||
> **Category:** [VMX (Altivec)](../categories/vmx.md) · **Form:** [VX](../forms/VX.md) · **Opcode:** `0x1000020a`
|
||
|
||
<!-- GENERATED: BEGIN -->
|
||
|
||
## Assembler Mnemonics
|
||
|
||
| Mnemonic | XML entry | Flags | Description |
|
||
| --- | --- | --- | --- |
|
||
| `vrfin` | `vrfin` | — | Vector Round to Floating-Point Integer Nearest |
|
||
| `vrfin128` | `vrfin128` | — | Vector128 Round to Floating-Point Integer Nearest |
|
||
|
||
## Syntax
|
||
|
||
```asm
|
||
vrfin [VD], [VB]
|
||
vrfin128 [VD], [VB]
|
||
```
|
||
|
||
## Encoding
|
||
|
||
### `vrfin` — form `VX`
|
||
|
||
- **Opcode word:** `0x1000020a`
|
||
- **Primary opcode (bits 0–5):** `4`
|
||
- **Extended opcode:** `522`
|
||
- **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) |
|
||
|
||
### `vrfin128` — form `VX128_3`
|
||
|
||
- **Opcode word:** `0x18000370`
|
||
- **Primary opcode (bits 0–5):** `6`
|
||
- **Extended opcode:** `880`
|
||
- **Synchronising:** no
|
||
|
||
| Bits | Field | Meaning |
|
||
| --- | --- | --- |
|
||
| 0–5 | `OPCD` | primary opcode (6) |
|
||
| 6–10 | `VD128l` | destination low 5 bits |
|
||
| 11–15 | `IMM` | 5-bit immediate |
|
||
| 16–20 | `VB128l` | source B low 5 bits |
|
||
| 21–27 | `XO` | extended opcode |
|
||
| 28–29 | `VD128h` | destination high 2 bits |
|
||
| 30–31 | `VB128h` | source B high 2 bits |
|
||
|
||
## Operands
|
||
|
||
| Field | Role | Description |
|
||
| --- | --- | --- |
|
||
| `VB` | vrfin: read; vrfin128: read | Source B vector register. |
|
||
| `VD` | vrfin: write; vrfin128: write | Destination vector register. |
|
||
|
||
## Register Effects
|
||
|
||
### `vrfin`
|
||
|
||
- **Reads (always):** `VB`
|
||
- **Reads (conditional):** _none_
|
||
- **Writes (always):** `VD`
|
||
- **Writes (conditional):** _none_
|
||
|
||
### `vrfin128`
|
||
|
||
- **Reads (always):** `VB`
|
||
- **Reads (conditional):** _none_
|
||
- **Writes (always):** `VD`
|
||
- **Writes (conditional):** _none_
|
||
|
||
## Status-Register Effects
|
||
|
||
_No condition-register or status-register effects._
|
||
|
||
## 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
|
||
|
||
```c
|
||
/* 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
|
||
|
||
**`vrfin`**
|
||
- Canary XML: [`tools/ppc-instructions.xml` — search for `mnem="vrfin"`](https://github.com/xenia-canary/xenia-canary/blob/f21ebd49e979e44f081f474df78c3fbfee9cb3f2/tools/ppc-instructions.xml)
|
||
- Canary emitter: [`src/xenia/cpu/ppc/ppc_emit_altivec.cc:1229`](https://github.com/xenia-canary/xenia-canary/blob/f21ebd49e979e44f081f474df78c3fbfee9cb3f2/src/xenia/cpu/ppc/ppc_emit_altivec.cc#L1229)
|
||
- Sylpheed opcode: [`crates/sylpheed-ppc/src/opcode.rs:425`](../../../crates/sylpheed-ppc/src/opcode.rs#L425)
|
||
- Sylpheed decoder: [`crates/sylpheed-ppc/src/decoder.rs:594`](../../../crates/sylpheed-ppc/src/decoder.rs#L594)
|
||
<details><summary>Canary emitter (frozen snapshot @ <code>f21ebd49e9</code>)</summary>
|
||
|
||
```cpp
|
||
int InstrEmit_vrfin(PPCHIRBuilder& f, const InstrData& i) {
|
||
return InstrEmit_vrfin_(f, i.VX.VD, i.VX.VB);
|
||
}
|
||
|
||
// ── delegates to (src/xenia/cpu/ppc/ppc_emit_altivec.cc:1223) ──
|
||
int InstrEmit_vrfin_(PPCHIRBuilder& f, uint32_t vd, uint32_t vb) {
|
||
// (VD) <- RoundToNearest(VB)
|
||
Value* v = f.Round(f.LoadVR(vb), ROUND_TO_NEAREST);
|
||
f.StoreVR(vd, v);
|
||
return 0;
|
||
}
|
||
```
|
||
</details>
|
||
|
||
**`vrfin128`**
|
||
- Canary XML: [`tools/ppc-instructions.xml` — search for `mnem="vrfin128"`](https://github.com/xenia-canary/xenia-canary/blob/f21ebd49e979e44f081f474df78c3fbfee9cb3f2/tools/ppc-instructions.xml)
|
||
- Canary emitter: [`src/xenia/cpu/ppc/ppc_emit_altivec.cc:1232`](https://github.com/xenia-canary/xenia-canary/blob/f21ebd49e979e44f081f474df78c3fbfee9cb3f2/src/xenia/cpu/ppc/ppc_emit_altivec.cc#L1232)
|
||
- Sylpheed opcode: [`crates/sylpheed-ppc/src/opcode.rs:426`](../../../crates/sylpheed-ppc/src/opcode.rs#L426)
|
||
- Sylpheed decoder: [`crates/sylpheed-ppc/src/decoder.rs:776`](../../../crates/sylpheed-ppc/src/decoder.rs#L776)
|
||
<details><summary>Canary emitter (frozen snapshot @ <code>f21ebd49e9</code>)</summary>
|
||
|
||
```cpp
|
||
int InstrEmit_vrfin128(PPCHIRBuilder& f, const InstrData& i) {
|
||
return InstrEmit_vrfin_(f, VX128_3_VD128, VX128_3_VB128);
|
||
}
|
||
|
||
// ── delegates to (src/xenia/cpu/ppc/ppc_emit_altivec.cc:1223) ──
|
||
int InstrEmit_vrfin_(PPCHIRBuilder& f, uint32_t vd, uint32_t vb) {
|
||
// (VD) <- RoundToNearest(VB)
|
||
Value* v = f.Round(f.LoadVR(vb), ROUND_TO_NEAREST);
|
||
f.StoreVR(vd, v);
|
||
return 0;
|
||
}
|
||
```
|
||
</details>
|
||
|
||
<!-- GENERATED: END -->
|
||
|
||
## Special Cases & Edge Conditions
|
||
|
||
- **Round to nearest integer.** Each 32-bit float lane of `VB` is rounded to the nearest representable integer value, ties to even on Xenon. Canary emits `vroundps` with rounding mode 0, which is round-half-to-even — a match.
|
||
- **IEEE-754 binary32 output; `VSCR[NJ]` honoured.**
|
||
- **Integer-too-big lanes are no-ops** (|x| ≥ 2²³).
|
||
- **NaN and ±∞** pass through unchanged.
|
||
- **No VSCR[SAT], no FPSCR update.**
|
||
- **Big-endian lane indexing.**
|
||
- **VMX128 sibling `vrfin128`.**
|
||
|
||
## Related Instructions
|
||
|
||
- [`vrfim`](vrfim.md) — round toward −∞.
|
||
- [`vrfip`](vrfip.md) — round toward +∞.
|
||
- [`vrfiz`](vrfiz.md) — round toward zero.
|
||
- [`vctsxs`](vctsxs.md), [`vctuxs`](vctuxs.md) — float → fixed-point integer.
|
||
|
||
## IBM Reference
|
||
|
||
- [AIX 7.3 — `vrfin` (Vector Round to Floating-Point Integer to Nearest)](https://www.ibm.com/docs/en/aix/7.3.0?topic=set-vrfin-vector-round-floating-point-integer-nearest-instruction)
|
||
- [IBM AltiVec Technology Programmer's Interface Manual, Chapter 5 — Floating-Point Arithmetic](https://www.nxp.com/docs/en/reference-manual/ALTIVECPIM.pdf)
|