Files
xenia-rs/migration/project-root/ppc-manual/vmx/vsum2sws.md
MechaCat02 e6d43a23ac chore: add migration/ bundle for cross-machine setup
Bundles state that lives OUTSIDE the xenia-rs repo so a fresh clone on
another machine can be brought up to identical configuration via
migration/setup.sh:

  - claude-memory/             ~/.claude/projects/-home-fabi-RE-Project-Sylpheed/memory/
                               (103 files, 1.1 MB - MEMORY.md + every
                                project_xenia_rs_*.md from audits
                                addis_signext through audit-058)
  - project-root/dot-claude/   <project-root>/.claude/settings.json
                               (Stop hook + permissions)
  - project-root/ppc-manual/   <project-root>/ppc-manual/
                               (PowerPC reference docs, 397 files, 3.7 MB)
  - project-root/run-canary.sh <project-root>/run-canary.sh
  - README.md                  Human-readable setup checklist
  - setup.sh                   Idempotent installer (also reclones
                               xenia-canary at pinned HEAD 6de80dffe)
  - MANIFEST.md                Per-file mapping + per-file-not-bundled
                               restoration recipe

Excluded from bundle (not shippable via git):
  - Sylpheed ISO (7.8 GB; copyright; manual copy required)
  - sylpheed.db (395 MB; regenerable from XEX via analysis tooling)
  - target/ build artifacts (rebuild on target)
  - audit-runs probe firehoses (.log/.stdout/.stderr ~11 GB; rerun if needed)
  - audit-runs memory dumps (.bin ~4.5 GB; rerun audit-026/027/029 if needed)
  - xenia-canary checkout (setup.sh reclones from
    git.mc02.dev/fabi/Xenia-Canary.git at HEAD 6de80dffe)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-10 21:38:38 +02:00

134 lines
5.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# `vsum2sws` — Vector Sum Across Partial (1/2) Signed Word Saturate
> **Category:** [VMX (Altivec)](../categories/vmx.md) · **Form:** [VX](../forms/VX.md) · **Opcode:** `0x10000688`
<!-- GENERATED: BEGIN -->
## Assembler Mnemonics
| Mnemonic | XML entry | Flags | Description |
| --- | --- | --- | --- |
| `vsum2sws` | `vsum2sws` | — | Vector Sum Across Partial (1/2) Signed Word Saturate |
## Syntax
```asm
vsum2sws [VD], [VA], [VB]
```
## Encoding
### `vsum2sws` — form `VX`
- **Opcode word:** `0x10000688`
- **Primary opcode (bits 05):** `4`
- **Extended opcode:** `1672`
- **Synchronising:** no
| Bits | Field | Meaning |
| --- | --- | --- |
| 05 | `OPCD` | primary opcode (4) |
| 610 | `VRT/VD` | destination vector register |
| 1115 | `VRA/VA` | source A vector register |
| 1620 | `VRB/VB` | source B vector register |
| 2131 | `XO` | extended opcode (11 bits) |
## Operands
| Field | Role | Description |
| --- | --- | --- |
| `VA` | vsum2sws: read | Source A vector register. |
| `VB` | vsum2sws: read | Source B vector register. |
| `VD` | vsum2sws: write | Destination vector register. |
| `VSCR` | vsum2sws: write | Vector Status and Control Register (NJ/SAT bits). |
## Register Effects
### `vsum2sws`
- **Reads (always):** `VA`, `VB`
- **Reads (conditional):** _none_
- **Writes (always):** `VD`, `VSCR`
- **Writes (conditional):** _none_
## Status-Register Effects
- `vsum2sws`: **VSCR[SAT]** may be stickied on saturating vector operations.
## 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
**`vsum2sws`**
- xenia-canary XML: [`tools/ppc-instructions.xml` — search for `mnem="vsum2sws"`](../../xenia-canary/tools/ppc-instructions.xml)
- xenia-canary emit: [`src/xenia/cpu/ppc/ppc_emit_altivec.cc:1776`](../../xenia-canary/src/xenia/cpu/ppc/ppc_emit_altivec.cc#L1776)
- xenia-rs opcode: [`crates/xenia-cpu/src/opcode.rs:127`](../../xenia-rs/crates/xenia-cpu/src/opcode.rs#L127)
- xenia-rs decoder: [`crates/xenia-cpu/src/decoder.rs:545`](../../xenia-rs/crates/xenia-cpu/src/decoder.rs#L545)
- xenia-rs interpreter: [`crates/xenia-cpu/src/interpreter.rs:3668-3679`](../../xenia-rs/crates/xenia-cpu/src/interpreter.rs#L3668-L3679)
<details><summary>xenia-rs interpreter body (frozen snapshot)</summary>
```rust
PpcOpcode::vsum2sws => {
// Two 2-word partial sums at lanes 1 and 3.
let a = crate::vmx::as_i32x4(ctx.vr[instr.ra()]);
let c = crate::vmx::as_i32x4(ctx.vr[instr.rb()]);
let s0 = a[0] as i64 + a[1] as i64 + c[1] as i64;
let s1 = a[2] as i64 + a[3] as i64 + c[3] as i64;
let (v0, sat0) = crate::vmx::sat_i64_to_i32(s0);
let (v1, sat1) = crate::vmx::sat_i64_to_i32(s1);
if sat0 | sat1 { ctx.set_vscr_sat(true); }
ctx.vr[instr.rd()] = crate::vmx::from_i32x4([0, v0, 0, v1]);
ctx.pc += 4;
}
```
</details>
<!-- GENERATED: END -->
## Special Cases & Edge Conditions
- **Two 2-word partial sums.** The four signed-word lanes of `VA` are split into two pairs: `{VA.w[0], VA.w[1]}` and `{VA.w[2], VA.w[3]}`. Each pair is summed, then added to the matching "anchor" word of `VB` (`VB.w[1]` and `VB.w[3]` respectively). Each 33-bit intermediate result is saturated to `int32`.
- **Output lane placement.** `VD.w[0] = 0`, `VD.w[1] = sat(VA.w[0] + VA.w[1] + VB.w[1])`, `VD.w[2] = 0`, `VD.w[3] = sat(VA.w[2] + VA.w[3] + VB.w[3])`. The zero lanes are specified in the ISA — software that wants a contiguous pair must `vmrglw` / `vmrghw` afterwards.
- **Sticky VSCR[SAT]** set when either saturating truncation occurs.
- **Big-endian word lanes.**
- **No `Rc`, no XER.**
- **No VMX128 sibling.**
## Related Instructions
- [`vsumsws`](vsumsws.md) — full 4-lane sum.
- [`vsum4sbs`](vsum4sbs.md), [`vsum4shs`](vsum4shs.md), [`vsum4ubs`](vsum4ubs.md) — per-word partial sums at narrower input widths.
- [`vaddsws`](vaddsws.md), [`vsubsws`](vsubsws.md) — word-saturating arithmetic.
## IBM Reference
- [AIX 7.3 — `vsum2sws` (Vector Sum across Partial (1/2) Saturated Word)](https://www.ibm.com/docs/en/aix/7.3.0?topic=set-vsum2sws-vector-sum-across-partial-12-saturated-word-instruction)
- [IBM AltiVec Technology Programmer's Interface Manual, Chapter 4 — Integer Arithmetic](https://www.nxp.com/docs/en/reference-manual/ALTIVECPIM.pdf)