(no commit message)
[libreriscv.git] / openpower / sv / svp64 / appendix.mdwn
1 [[!tag standards]]
2
3 # Appendix
4
5 * <https://bugs.libre-soc.org/show_bug.cgi?id=574> Saturation
6 * <https://bugs.libre-soc.org/show_bug.cgi?id=558#c47> Parallel Prefix
7 * <https://bugs.libre-soc.org/show_bug.cgi?id=697> Reduce Modes
8 * <https://bugs.libre-soc.org/show_bug.cgi?id=864> parallel prefix simulator
9 * <https://bugs.libre-soc.org/show_bug.cgi?id=809> OV sv.addex discussion
10 * ARM SVE Fault-first <https://alastairreid.github.io/papers/sve-ieee-micro-2017.pdf>
11
12 This is the appendix to [[sv/svp64]], providing explanations of modes
13 etc. leaving the main svp64 page's primary purpose as outlining the
14 instruction format.
15
16 Table of contents:
17
18 [[!toc]]
19
20 # Partial Implementations
21
22 It is perfectly legal to implement subsets of SVP64 as long as illegal
23 instruction traps are always raised on unimplemented features,
24 so that soft-emulation is possible,
25 even for future revisions of SVP64. With SVP64 being partly controlled
26 through contextual SPRs, a little care has to be taken.
27
28 **All** SPRs
29 not implemented including reserved ones for future use must raise an illegal
30 instruction trap if read or written. This allows software the
31 opportunity to emulate the context created by the given SPR.
32
33 See [[sv/compliancy_levels]] for full details.
34
35 # XER, SO and other global flags
36
37 Vector systems are expected to be high performance. This is achieved
38 through parallelism, which requires that elements in the vector be
39 independent. XER SO/OV and other global "accumulation" flags (CR.SO) cause
40 Read-Write Hazards on single-bit global resources, having a significant
41 detrimental effect.
42
43 Consequently in SV, XER.SO behaviour is disregarded (including
44 in `cmp` instructions). XER.SO is not read, but XER.OV may be written,
45 breaking the Read-Modify-Write Hazard Chain that complicates
46 microarchitectural implementations.
47 This includes when `scalar identity behaviour` occurs. If precise
48 OpenPOWER v3.0/1 scalar behaviour is desired then OpenPOWER v3.0/1
49 instructions should be used without an SV Prefix.
50
51 TODO jacob add about OV https://www.intel.com/content/dam/www/public/us/en/documents/white-papers/ia-large-integer-arithmetic-paper.pdf
52
53 Of note here is that XER.SO and OV may already be disregarded in the
54 Power ISA v3.0/1 SFFS (Scalar Fixed and Floating) Compliancy Subset.
55 SVP64 simply makes it mandatory to disregard XER.SO even for other Subsets,
56 but only for SVP64 Prefixed Operations.
57
58 XER.CA/CA32 on the other hand is expected and required to be implemented
59 according to standard Power ISA Scalar behaviour. Interestingly, due
60 to SVP64 being in effect a hardware for-loop around Scalar instructions
61 executing in precise Program Order, a little thought shows that a Vectorised
62 Carry-In-Out add is in effect a Big Integer Add, taking a single bit Carry In
63 and producing, at the end, a single bit Carry out. High performance
64 implementations may exploit this observation to deploy efficient
65 Parallel Carry Lookahead.
66
67 # assume VL=4, this results in 4 sequential ops (below)
68 sv.adde r0.v, r4.v, r8.v
69
70 # instructions that get executed in backend hardware:
71 adde r0, r4, r8 # takes carry-in, produces carry-out
72 adde r1, r5, r9 # takes carry from previous
73 ...
74 adde r3, r7, r11 # likewise
75
76 It can clearly be seen that the carry chains from one
77 64 bit add to the next, the end result being that a
78 256-bit "Big Integer Add with Carry" has been performed, and that
79 CA contains the 257th bit. A one-instruction 512-bit Add-with-Carry
80 may be performed by setting VL=8, and a one-instruction
81 1024-bit Add-with-Carry by setting VL=16, and so on. More on
82 this in [[openpower/sv/biginteger]]
83
84 # v3.0B/v3.1 relevant instructions
85
86 SV is primarily designed for use as an efficient hybrid 3D GPU / VPU /
87 CPU ISA.
88
89 Vectorisation of the VSX Packed SIMD system makes no sense whatsoever,
90 the sole exceptions potentially being any operations with 128-bit
91 operands such as `vrlq` (Rotate Quad Word) and `xsaddqp` (Scalar
92 Quad-precision Add).
93 SV effectively *replaces* the majority of VSX, requiring far less
94 instructions, and provides, at the very minimum, predication
95 (which VSX was designed without).
96
97 Likewise, Load/Store Multiple make no sense to
98 have because they are not only provided by SV, the SV alternatives may
99 be predicated as well, making them far better suited to use in function
100 calls and context-switching.
101
102 Additionally, some v3.0/1 instructions simply make no sense at all in a
103 Vector context: `rfid` falls into this category,
104 as well as `sc` and `scv`. Here there is simply no point
105 trying to Vectorise them: the standard OpenPOWER v3.0/1 instructions
106 should be called instead.
107
108 Fortuitously this leaves several Major Opcodes free for use by SV
109 to fit alternative future instructions. In a 3D context this means
110 Vector Product, Vector Normalise, [[sv/mv.swizzle]], Texture LD/ST
111 operations, and others critical to an efficient, effective 3D GPU and
112 VPU ISA. With such instructions being included as standard in other
113 commercially-successful GPU ISAs it is likewise critical that a 3D
114 GPU/VPU based on svp64 also have such instructions.
115
116 Note however that svp64 is stand-alone and is in no way
117 critically dependent on the existence or provision of 3D GPU or VPU
118 instructions. These should be considered entirely separate
119 extensions, and their discussion
120 and specification is out of scope for this document.
121
122 ## Major opcode map (v3.0B)
123
124 This table is taken from v3.0B.
125 Table 9: Primary Opcode Map (opcode bits 0:5)
126
127 ```
128 | 000 | 001 | 010 | 011 | 100 | 101 | 110 | 111
129 000 | | | tdi | twi | EXT04 | | | mulli | 000
130 001 | subfic | | cmpli | cmpi | addic | addic. | addi | addis | 001
131 010 | bc/l/a | EXT17 | b/l/a | EXT19 | rlwimi| rlwinm | | rlwnm | 010
132 011 | ori | oris | xori | xoris | andi. | andis. | EXT30 | EXT31 | 011
133 100 | lwz | lwzu | lbz | lbzu | stw | stwu | stb | stbu | 100
134 101 | lhz | lhzu | lha | lhau | sth | sthu | lmw | stmw | 101
135 110 | lfs | lfsu | lfd | lfdu | stfs | stfsu | stfd | stfdu | 110
136 111 | lq | EXT57 | EXT58 | EXT59 | EXT60 | EXT61 | EXT62 | EXT63 | 111
137 | 000 | 001 | 010 | 011 | 100 | 101 | 110 | 111
138 ```
139
140 It is important to note that having a different v3.0B Scalar opcode
141 that is different from an SVP64 one is highly undesirable: the complexity
142 in the decoder is greatly increased, through breaking of the RISC paradigm.
143
144 # EXTRA Field Mapping
145
146 The purpose of the 9-bit EXTRA field mapping is to mark individual
147 registers (RT, RA, BFA) as either scalar or vector, and to extend
148 their numbering from 0..31 in Power ISA v3.0 to 0..127 in SVP64.
149 Three of the 9 bits may also be used up for a 2nd Predicate (Twin
150 Predication) leaving a mere 6 bits for qualifying registers. As can
151 be seen there is significant pressure on these (and in fact all) SVP64 bits.
152
153 In Power ISA v3.1 prefixing there are bits which describe and classify
154 the prefix in a fashion that is independent of the suffix. MLSS for
155 example. For SVP64 there is insufficient space to make the SVP64 Prefix
156 "self-describing", and consequently every single Scalar instruction
157 had to be individually analysed, by rote, to craft an EXTRA Field Mapping.
158 This process was semi-automated and is described in this section.
159 The final results, which are part of the SVP64 Specification, are here:
160 [[openpower/opcode_regs_deduped]]
161
162 * Firstly, every instruction's mnemonic (`add RT, RA, RB`) was analysed
163 from reading the markdown formatted version of the Scalar pseudocode
164 which is machine-readable and found in [[openpower/isatables]]. The
165 analysis gives, by instruction, a "Register Profile". `add RT, RA, RB`
166 for example is given a designation `RM-2R-1W` because it requires
167 two GPR reads and one GPR write.
168 * Secondly, the total number of registers was added up (2R-1W is 3 registers)
169 and if less than or equal to three then that instruction could be given an
170 EXTRA3 designation. Four or more is given an EXTRA2 designation because
171 there are only 9 bits available.
172 * Thirdly, the instruction was analysed to see if Twin or Single
173 Predication was suitable. As a general rule this was if there
174 was only a single operand and a single result (`extw` and LD/ST)
175 however it was found that some 2 or 3 operand instructions also
176 qualify. Given that 3 of the 9 bits of EXTRA had to be sacrificed for use
177 in Twin Predication, some compromises were made, here. LDST is
178 Twin but also has 3 operands in some operations, so only EXTRA2 can be used.
179 * Fourthly, a packing format was decided: for 2R-1W an EXTRA3 indexing
180 could have been decided
181 that RA would be indexed 0 (EXTRA bits 0-2), RB indexed 1 (EXTRA bits 3-5)
182 and RT indexed 2 (EXTRA bits 6-8). In some cases (LD/ST with update)
183 RA-as-a-source is given a **different** EXTRA index from RA-as-a-result
184 (because it is possible to do, and perceived to be useful). Rc=1
185 co-results (CR0, CR1) are always given the same EXTRA index as their
186 main result (RT, FRT).
187 * Fifthly, in an automated process the results of the analysis
188 were outputted in CSV Format for use in machine-readable form
189 by sv_analysis.py <https://git.libre-soc.org/?p=openpower-isa.git;a=blob;f=src/openpower/sv/sv_analysis.py;hb=HEAD>
190
191 This process was laborious but logical, and, crucially, once a
192 decision is made (and ratified) cannot be reversed.
193 Qualifying future Power ISA Scalar instructions for SVP64
194 is **strongly** advised to utilise this same process and the same
195 sv_analysis.py program as a canonical method of maintaining the
196 relationships. Alterations to that same program which
197 change the Designation is **prohibited** once finalised (ratified
198 through the Power ISA WG Process). It would
199 be similar to deciding that `add` should be changed from X-Form
200 to D-Form.
201
202 # Single Predication <a name="1p"> </a>
203
204 This is a standard mode normally found in Vector ISAs. every element in every source Vector and in the destination uses the same bit of one single predicate mask.
205
206 In SVSTATE, for Single-predication, implementors MUST increment both srcstep and dststep, but depending on whether sz and/or dz are set, srcstep and
207 dststep can still potentially become different indices. Only when sz=dz
208 is srcstep guaranteed to equal dststep at all times.
209
210 Note that in some Mode Formats there is only one flag (zz). This indicates
211 that *both* sz *and* dz are set to the same.
212
213 Example 1:
214
215 * VL=4
216 * mask=0b1101
217 * sz=0, dz=1
218
219 The following schedule for srcstep and dststep will occur:
220
221 | srcstep | dststep | comment |
222 | ---- | ----- | -------- |
223 | 0 | 0 | both mask[src=0] and mask[dst=0] are 1 |
224 | 1 | 2 | sz=1 but dz=0: dst skips mask[1], src soes not |
225 | 2 | 3 | mask[src=2] and mask[dst=3] are 1 |
226 | end | end | loop has ended because dst reached VL-1 |
227
228 Example 2:
229
230 * VL=4
231 * mask=0b1101
232 * sz=1, dz=0
233
234 The following schedule for srcstep and dststep will occur:
235
236 | srcstep | dststep | comment |
237 | ---- | ----- | -------- |
238 | 0 | 0 | both mask[src=0] and mask[dst=0] are 1 |
239 | 2 | 1 | sz=0 but dz=1: src skips mask[1], dst does not |
240 | 3 | 2 | mask[src=3] and mask[dst=2] are 1 |
241 | end | end | loop has ended because src reached VL-1 |
242
243 In both these examples it is crucial to note that despite there being
244 a single predicate mask, with sz and dz being different, srcstep and
245 dststep are being requested to react differently.
246
247 Example 3:
248
249 * VL=4
250 * mask=0b1101
251 * sz=0, dz=0
252
253 The following schedule for srcstep and dststep will occur:
254
255 | srcstep | dststep | comment |
256 | ---- | ----- | -------- |
257 | 0 | 0 | both mask[src=0] and mask[dst=0] are 1 |
258 | 2 | 2 | sz=0 and dz=0: both src and dst skip mask[1] |
259 | 3 | 3 | mask[src=3] and mask[dst=3] are 1 |
260 | end | end | loop has ended because src and dst reached VL-1 |
261
262 Here, both srcstep and dststep remain in lockstep because sz=dz=1
263
264 # Twin Predication <a name="2p"> </a>
265
266 This is a novel concept that allows predication to be applied to a single
267 source and a single dest register. The following types of traditional
268 Vector operations may be encoded with it, *without requiring explicit
269 opcodes to do so*
270
271 * VSPLAT (a single scalar distributed across a vector)
272 * VEXTRACT (like LLVM IR [`extractelement`](https://releases.llvm.org/11.0.0/docs/LangRef.html#extractelement-instruction))
273 * VINSERT (like LLVM IR [`insertelement`](https://releases.llvm.org/11.0.0/docs/LangRef.html#insertelement-instruction))
274 * VCOMPRESS (like LLVM IR [`llvm.masked.compressstore.*`](https://releases.llvm.org/11.0.0/docs/LangRef.html#llvm-masked-compressstore-intrinsics))
275 * VEXPAND (like LLVM IR [`llvm.masked.expandload.*`](https://releases.llvm.org/11.0.0/docs/LangRef.html#llvm-masked-expandload-intrinsics))
276
277 Those patterns (and more) may be applied to:
278
279 * mv (the usual way that V\* ISA operations are created)
280 * exts\* sign-extension
281 * rwlinm and other RS-RA shift operations (**note**: excluding
282 those that take RA as both a src and dest. These are not
283 1-src 1-dest, they are 2-src, 1-dest)
284 * LD and ST (treating AGEN as one source)
285 * FP fclass, fsgn, fneg, fabs, fcvt, frecip, fsqrt etc.
286 * Condition Register ops mfcr, mtcr and other similar
287
288 This is a huge list that creates extremely powerful combinations,
289 particularly given that one of the predicate options is `(1<<r3)`
290
291 Additional unusual capabilities of Twin Predication include a back-to-back
292 version of VCOMPRESS-VEXPAND which is effectively the ability to do
293 sequentially ordered multiple VINSERTs. The source predicate selects a
294 sequentially ordered subset of elements to be inserted; the destination
295 predicate specifies the sequentially ordered recipient locations.
296 This is equivalent to
297 `llvm.masked.compressstore.*`
298 followed by
299 `llvm.masked.expandload.*`
300 with a single instruction.
301
302 This extreme power and flexibility comes down to the fact that SVP64
303 is not actually a Vector ISA: it is a loop-abstraction-concept that
304 is applied *in general* to Scalar operations, just like the x86
305 `REP` instruction (if put on steroids).
306
307 # EXTRA Pack/Unpack Modes
308
309 The pack/unpack concept of VSX `vpack` is abstracted out as a Sub-Vector
310 reordering Schedule, named `RM-2P-1S1D-PU`.
311 The usual RM-2P-1S1D is reduced from EXTRA3 to EXTRA2, making
312 room for 2 extra bits that enable either "packing" or "unpacking"
313 on the subvectors vec2/3/4.
314
315 Illustrating a
316 "normal" SVP64 operation with `SUBVL!=1:` (assuming no elwidth overrides):
317
318 def index():
319 for i in range(VL):
320 for j in range(SUBVL):
321 yield i*SUBVL+j
322
323 for idx in index():
324 operation_on(RA+idx)
325
326 For pack/unpack (again, no elwidth overrides):
327
328 # yield an outer-SUBVL or inner VL loop with SUBVL
329 def index_p(outer):
330 if outer:
331 for j in range(SUBVL):
332 for i in range(VL):
333 yield i+VL*j
334 else:
335 for i in range(VL):
336 for j in range(SUBVL):
337 yield i*SUBVL+j
338
339 # walk through both source and dest indices simultaneously
340 for src_idx, dst_idx in zip(index_p(PACK), index_p(UNPACK)):
341 move_operation(RT+dst_idx, RA+src_idx)
342
343 "yield" from python is used here for simplicity and clarity.
344 The two Finite State Machines for the generation of the source
345 and destination element offsets progress incrementally in
346 lock-step.
347
348 Example VL=2, SUBVL=3, PACK_en=1 - elements grouped by
349 vec3 will be redistributed such that Sub-elements 0 are
350 packed together, Sub-elements 1 are packed together, as
351 are Sub-elements 2.
352
353 srcstep=0 srcstep=1
354 0 1 2 3 4 5
355
356 dststep=0 dststep=1 dststep=2
357 0 3 1 4 2 5
358
359 Setting of both `PACK_en` and `UNPACK_en` is neither prohibited nor
360 `UNDEFINED` because the reordering is fully deterministic, and
361 additional REMAP reordering may be applied. For Matrix this would
362 give potentially up to 4 Dimensions of reordering.
363
364 Pack/Unpack applies to mv operations, mv.swizzle,
365 and some other single-source
366 single-destination operations such as Indexed LD/ST and extsw.
367 [[sv/mv.swizzle]] has a slightly different pseudocode algorithm
368 for Vertical-First Mode.
369
370 # Reduce modes
371
372 Reduction in SVP64 is deterministic and somewhat of a misnomer. A normal
373 Vector ISA would have explicit Reduce opcodes with defined characteristics
374 per operation: in SX Aurora there is even an additional scalar argument
375 containing the initial reduction value, and the default is either 0
376 or 1 depending on the specifics of the explicit opcode.
377 SVP64 fundamentally has to
378 utilise *existing* Scalar Power ISA v3.0B operations, which presents some
379 unique challenges.
380
381 The solution turns out to be to simply define reduction as permitting
382 deterministic element-based schedules to be issued using the base Scalar
383 operations, and to rely on the underlying microarchitecture to resolve
384 Register Hazards at the element level. This goes back to
385 the fundamental principle that SV is nothing more than a Sub-Program-Counter
386 sitting between Decode and Issue phases.
387
388 For Scalar Reduction,
389 Microarchitectures *may* take opportunities to parallelise the reduction
390 but only if in doing so they preserve strict Program Order at the Element Level.
391 Opportunities where this is possible include an `OR` operation
392 or a MIN/MAX operation: it may be possible to parallelise the reduction,
393 but for Floating Point it is not permitted due to different results
394 being obtained if the reduction is not executed in strict Program-Sequential
395 Order.
396
397 In essence it becomes the programmer's responsibility to leverage the
398 pre-determined schedules to desired effect.
399
400 ## Scalar result reduction and iteration
401
402 Scalar Reduction per se does not exist, instead is implemented in SVP64
403 as a simple and natural relaxation of the usual restriction on the Vector
404 Looping which would terminate if the destination was marked as a Scalar.
405 Scalar Reduction by contrast *keeps issuing Vector Element Operations*
406 even though the destination register is marked as scalar.
407 Thus it is up to the programmer to be aware of this, observe some
408 conventions, and thus end up achieving the desired outcome of scalar
409 reduction.
410
411 It is also important to appreciate that there is no
412 actual imposition or restriction on how this mode is utilised: there
413 will therefore be several valuable uses (including Vector Iteration
414 and "Reverse-Gear")
415 and it is up to the programmer to make best use of the
416 (strictly deterministic) capability
417 provided.
418
419 In this mode, which is suited to operations involving carry or overflow,
420 one register must be assigned, by convention by the programmer to be the
421 "accumulator". Scalar reduction is thus categorised by:
422
423 * One of the sources is a Vector
424 * the destination is a scalar
425 * optionally but most usefully when one source scalar register is
426 also the scalar destination (which may be informally termed
427 the "accumulator")
428 * That the source register type is the same as the destination register
429 type identified as the "accumulator". Scalar reduction on `cmp`,
430 `setb` or `isel` makes no sense for example because of the mixture
431 between CRs and GPRs.
432
433 *Note that issuing instructions in Scalar reduce mode such as `setb`
434 are neither `UNDEFINED` nor prohibited, despite them not making much
435 sense at first glance.
436 Scalar reduce is strictly defined behaviour, and the cost in
437 hardware terms of prohibition of seemingly non-sensical operations is too great.
438 Therefore it is permitted and required to be executed successfully.
439 Implementors **MAY** choose to optimise such instructions in instances
440 where their use results in "extraneous execution", i.e. where it is clear
441 that the sequence of operations, comprising multiple overwrites to
442 a scalar destination **without** cumulative, iterative, or reductive
443 behaviour (no "accumulator"), may discard all but the last element
444 operation. Identification
445 of such is trivial to do for `setb` and `cmp`: the source register type is
446 a completely different register file from the destination.
447 Likewise Scalar reduction when the destination is a Vector
448 is as if the Reduction Mode was not requested. However it would clearly
449 be unacceptable to perform such optimisations on cache-inhibited LD/ST,
450 so some considerable care needs to be taken.*
451
452 Typical applications include simple operations such as `ADD r3, r10.v,
453 r3` where, clearly, r3 is being used to accumulate the addition of all
454 elements of the vector starting at r10.
455
456 # add RT, RA,RB but when RT==RA
457 for i in range(VL):
458 iregs[RA] += iregs[RB+i] # RT==RA
459
460 However, *unless* the operation is marked as "mapreduce" (`sv.add/mr`)
461 SV ordinarily
462 **terminates** at the first scalar operation. Only by marking the
463 operation as "mapreduce" will it continue to issue multiple sub-looped
464 (element) instructions in `Program Order`.
465
466 To perform the loop in reverse order, the ```RG``` (reverse gear) bit must be set. This may be useful in situations where the results may be different
467 (floating-point) if executed in a different order. Given that there is
468 no actual prohibition on Reduce Mode being applied when the destination
469 is a Vector, the "Reverse Gear" bit turns out to be a way to apply Iterative
470 or Cumulative Vector operations in reverse. `sv.add/rg r3.v, r4.v, r4.v`
471 for example will start at the opposite end of the Vector and push
472 a cumulative series of overlapping add operations into the Execution units of
473 the underlying hardware.
474
475 Other examples include shift-mask operations where a Vector of inserts
476 into a single destination register is required (see [[sv/bitmanip]], bmset),
477 as a way to construct
478 a value quickly from multiple arbitrary bit-ranges and bit-offsets.
479 Using the same register as both the source and destination, with Vectors
480 of different offsets masks and values to be inserted has multiple
481 applications including Video, cryptography and JIT compilation.
482
483 # assume VL=4:
484 # * Vector of shift-offsets contained in RC (r12.v)
485 # * Vector of masks contained in RB (r8.v)
486 # * Vector of values to be masked-in in RA (r4.v)
487 # * Scalar destination RT (r0) to receive all mask-offset values
488 sv.bmset/mr r0, r4.v, r8.v, r12.v
489
490 Due to the Deterministic Scheduling,
491 Subtract and Divide are still permitted to be executed in this mode,
492 although from an algorithmic perspective it is strongly discouraged.
493 It would be better to use addition followed by one final subtract,
494 or in the case of divide, to get better accuracy, to perform a multiply
495 cascade followed by a final divide.
496
497 Note that single-operand or three-operand scalar-dest reduce is perfectly
498 well permitted: the programmer may still declare one register, used as
499 both a Vector source and Scalar destination, to be utilised as
500 the "accumulator". In the case of `sv.fmadds` and `sv.maddhw` etc
501 this naturally fits well with the normal expected usage of these
502 operations.
503
504 If an interrupt or exception occurs in the middle of the scalar mapreduce,
505 the scalar destination register **MUST** be updated with the current
506 (intermediate) result, because this is how ```Program Order``` is
507 preserved (Vector Loops are to be considered to be just another way of issuing instructions
508 in Program Order). In this way, after return from interrupt,
509 the scalar mapreduce may continue where it left off. This provides
510 "precise" exception behaviour.
511
512 Note that hardware is perfectly permitted to perform multi-issue
513 parallel optimisation of the scalar reduce operation: it's just that
514 as far as the user is concerned, all exceptions and interrupts **MUST**
515 be precise.
516
517 ## Vector result reduce mode
518
519 Vector Reduce Mode issues a deterministic tree-reduction schedule to the underlying micro-architecture. Like Scalar reduction, the "Scalar Base"
520 (Power ISA v3.0B) operation is leveraged, unmodified, to give the
521 *appearance* and *effect* of Reduction.
522
523 In Horizontal-First Mode, Vector-result reduction **requires**
524 the destination to be a Vector, which will be used to store
525 intermediary results.
526
527 Given that the tree-reduction schedule is deterministic,
528 Interrupts and exceptions
529 can therefore also be precise. The final result will be in the first
530 non-predicate-masked-out destination element, but due again to
531 the deterministic schedule programmers may find uses for the intermediate
532 results.
533
534 When Rc=1 a corresponding Vector of co-resultant CRs is also
535 created. No special action is taken: the result and its CR Field
536 are stored "as usual" exactly as all other SVP64 Rc=1 operations.
537
538 Note that the Schedule only makes sense on top of certain instructions:
539 X-Form with a Register Profile of `RT,RA,RB` is fine. Like Scalar
540 Reduction, nothing is prohibited:
541 the results of execution on an unsuitable instruction may simply
542 not make sense. Many 3-input instructions (madd, fmadd) unlike Scalar
543 Reduction in particular do not make sense, but `ternlogi`, if used
544 with care, would.
545
546 **Parallel-Reduction with Predication**
547
548 To avoid breaking the strict RISC-paradigm, keeping the Issue-Schedule
549 completely separate from the actual element-level (scalar) operations,
550 Move operations are **not** included in the Schedule. This means that
551 the Schedule leaves the final (scalar) result in the first-non-masked
552 element of the Vector used. With the predicate mask being dynamic
553 (but deterministic) this result could be anywhere.
554
555 If that result is needed to be moved to a (single) scalar register
556 then a follow-up `sv.mv/sm=predicate rt, ra.v` instruction will be
557 needed to get it, where the predicate is the exact same predicate used
558 in the prior Parallel-Reduction instruction. For *some* implementations
559 this may be a slow operation. It may be better to perform a pre-copy
560 of the values, compressing them (VREDUCE-style) into a contiguous block,
561 which will guarantee that the result goes into the very first element
562 of the destination vector.
563
564 **Usage conditions**
565
566 The simplest usage is to perform an overwrite, specifying all three
567 register operands the same.
568
569 setvl VL=6
570 sv.add/vr 8.v, 8.v, 8.v
571
572 The Reduction Schedule will issue the Parallel Tree Reduction spanning
573 registers 8 through 13, by adjusting the offsets to RT, RA and RB as
574 necessary (see "Parallel Reduction algorithm" in a later section).
575
576 A non-overwrite is possible as well but just as with the overwrite
577 version, only those destination elements necessary for storing
578 intermediary computations will be written to: the remaining elements
579 will **not** be overwritten and will **not** be zero'd.
580
581 setvl VL=4
582 sv.add/vr 0.v, 8.v, 8.v
583
584 ## Sub-Vector Horizontal Reduction
585
586 Note that when SVM is clear and SUBVL!=1 the sub-elements are
587 *independent*, i.e. they are mapreduced per *sub-element* as a result.
588 illustration with a vec2, assuming RA==RT, e.g `sv.add/mr/vec2 r4, r4, r16.v`
589
590 for i in range(0, VL):
591 # RA==RT in the instruction. does not have to be
592 iregs[RT].x = op(iregs[RT].x, iregs[RB+i].x)
593 iregs[RT].y = op(iregs[RT].y, iregs[RB+i].y)
594
595 Thus logically there is nothing special or unanticipated about
596 `SVM=0`: it is expected behaviour according to standard SVP64
597 Sub-Vector rules.
598
599 By contrast, when SVM is set and SUBVL!=1, a Horizontal
600 Subvector mode is enabled, which behaves very much more
601 like a traditional Vector Processor Reduction instruction.
602
603 Example for a vec2:
604
605 for i in range(VL):
606 iregs[RT+i] = op(iregs[RA+i].x, iregs[RB+i].y)
607
608 Example for a vec3:
609
610 for i in range(VL):
611 iregs[RT+i] = op(iregs[RA+i].x, iregs[RB+i].y)
612 iregs[RT+i] = op(iregs[RT+i] , iregs[RB+i].z)
613
614 Example for a vec4:
615
616 for i in range(VL):
617 iregs[RT+i] = op(iregs[RA+i].x, iregs[RB+i].y)
618 iregs[RT+i] = op(iregs[RT+i] , iregs[RB+i].z)
619 iregs[RT+i] = op(iregs[RT+i] , iregs[RB+i].w)
620
621 In this mode, when Rc=1 the Vector of CRs is as normal: each result
622 element creates a corresponding CR element (for the final, reduced, result).
623
624 Note:
625
626 1. that the destination (RT) is inherently used as an "Accumulator"
627 register, and consequently the Sub-Vector Loop is interruptible.
628 If RT is a Scalar then as usual the main VL Loop terminates at the
629 first predicated element (or the first element if unpredicated).
630 2. that the Sub-Vector designation applies to RA and RB *but not RT*.
631 3. that the number of operations executed is one less than the Sub-vector
632 length
633
634 # Fail-on-first <a name="fail-first"> </a>
635
636 Data-dependent fail-on-first has two distinct variants: one for LD/ST
637 (see [[sv/ldst]],
638 the other for arithmetic operations (actually, CR-driven)
639 [[sv/normal]] and CR operations [[sv/cr_ops]].
640 Note in each
641 case the assumption is that vector elements are required appear to be
642 executed in sequential Program Order, element 0 being the first.
643
644 * LD/ST ffirst treats the first LD/ST in a vector (element 0) as an
645 ordinary one. Exceptions occur "as normal". However for elements 1
646 and above, if an exception would occur, then VL is **truncated** to the
647 previous element.
648 * Data-driven (CR-driven) fail-on-first activates when Rc=1 or other
649 CR-creating operation produces a result (including cmp). Similar to
650 branch, an analysis of the CR is performed and if the test fails, the
651 vector operation terminates and discards all element operations
652 above the current one (and the current one if VLi is not set),
653 and VL is truncated to either
654 the *previous* element or the current one, depending on whether
655 VLi (VL "inclusive") is set.
656
657 Thus the new VL comprises a contiguous vector of results,
658 all of which pass the testing criteria (equal to zero, less than zero).
659
660 The CR-based data-driven fail-on-first is new and not found in ARM
661 SVE or RVV. At the same time it is also "old" because it is a generalisation
662 of the Z80
663 [Block compare](https://rvbelzen.tripod.com/z80prgtemp/z80prg04.htm)
664 instructions, especially
665 [CPIR](http://z80-heaven.wikidot.com/instructions-set:cpir)
666 which is based on CP (compare) as the ultimate "element" (suffix)
667 operation to which the repeat (prefix) is applied.
668 It is extremely useful for reducing instruction count,
669 however requires speculative execution involving modifications of VL
670 to get high performance implementations. An additional mode (RC1=1)
671 effectively turns what would otherwise be an arithmetic operation
672 into a type of `cmp`. The CR is stored (and the CR.eq bit tested
673 against the `inv` field).
674 If the CR.eq bit is equal to `inv` then the Vector is truncated and
675 the loop ends.
676 Note that when RC1=1 the result elements are never stored, only the CRs.
677
678 VLi is only available as an option when `Rc=0` (or for instructions
679 which do not have Rc). When set, the current element is always
680 also included in the count (the new length that VL will be set to).
681 This may be useful in combination with "inv" to truncate the Vector
682 to *exclude* elements that fail a test, or, in the case of implementations
683 of strncpy, to include the terminating zero.
684
685 In CR-based data-driven fail-on-first there is only the option to select
686 and test one bit of each CR (just as with branch BO). For more complex
687 tests this may be insufficient. If that is the case, a vectorised crops
688 (crand, cror) may be used, and ffirst applied to the crop instead of to
689 the arithmetic vector.
690
691 One extremely important aspect of ffirst is:
692
693 * LDST ffirst may never set VL equal to zero. This because on the first
694 element an exception must be raised "as normal".
695 * CR-based data-dependent ffirst on the other hand **can** set VL equal
696 to zero. This is the only means in the entirety of SV that VL may be set
697 to zero (with the exception of via the SV.STATE SPR). When VL is set
698 zero due to the first element failing the CR bit-test, all subsequent
699 vectorised operations are effectively `nops` which is
700 *precisely the desired and intended behaviour*.
701
702 Another aspect is that for ffirst LD/STs, VL may be truncated arbitrarily
703 to a nonzero value for any implementation-specific reason. For example:
704 it is perfectly reasonable for implementations to alter VL when ffirst
705 LD or ST operations are initiated on a nonaligned boundary, such that
706 within a loop the subsequent iteration of that loop begins subsequent
707 ffirst LD/ST operations on an aligned boundary. Likewise, to reduce
708 workloads or balance resources.
709
710 CR-based data-dependent first on the other hand MUST not truncate VL
711 arbitrarily to a length decided by the hardware: VL MUST only be
712 truncated based explicitly on whether a test fails.
713 This because it is a precise test on which algorithms
714 will rely.
715
716 ## Data-dependent fail-first on CR operations (crand etc)
717
718 Operations that actually produce or alter CR Field as a result
719 do not also in turn have an Rc=1 mode. However it makes no
720 sense to try to test the 4 bits of a CR Field for being equal
721 or not equal to zero. Moreover, the result is already in the
722 form that is desired: it is a CR field. Therefore,
723 CR-based operations have their own SVP64 Mode, described
724 in [[sv/cr_ops]]
725
726 There are two primary different types of CR operations:
727
728 * Those which have a 3-bit operand field (referring to a CR Field)
729 * Those which have a 5-bit operand (referring to a bit within the
730 whole 32-bit CR)
731
732 More details can be found in [[sv/cr_ops]].
733
734 # pred-result mode
735
736 Pred-result mode may not be applied on CR-based operations.
737
738 Although CR operations (mtcr, crand, cror) may be Vectorised,
739 predicated, pred-result mode applies to operations that have
740 an Rc=1 mode, or make sense to add an RC1 option.
741
742 Predicate-result merges common CR testing with predication, saving on
743 instruction count. In essence, a Condition Register Field test
744 is performed, and if it fails it is considered to have been
745 *as if* the destination predicate bit was zero. Given that
746 there are no CR-based operations that produce Rc=1 co-results,
747 there can be no pred-result mode for mtcr and other CR-based instructions
748
749 Arithmetic and Logical Pred-result, which does have Rc=1 or for which
750 RC1 Mode makes sense, is covered in [[sv/normal]]
751
752 # CR Operations
753
754 CRs are slightly more involved than INT or FP registers due to the
755 possibility for indexing individual bits (crops BA/BB/BT). Again however
756 the access pattern needs to be understandable in relation to v3.0B / v3.1B
757 numbering, with a clear linear relationship and mapping existing when
758 SV is applied.
759
760 ## CR EXTRA mapping table and algorithm <a name="cr_extra"></a>
761
762 Numbering relationships for CR fields are already complex due to being
763 in BE format (*the relationship is not clearly explained in the v3.0B
764 or v3.1 specification*). However with some care and consideration
765 the exact same mapping used for INT and FP regfiles may be applied,
766 just to the upper bits, as explained below. The notation
767 `CR{field number}` is used to indicate access to a particular
768 Condition Register Field (as opposed to the notation `CR[bit]`
769 which accesses one bit of the 32 bit Power ISA v3.0B
770 Condition Register)
771
772 `CR{n}` refers to `CR0` when `n=0` and consequently, for CR0-7, is defined, in v3.0B pseudocode, as:
773
774 CR{7-n} = CR[32+n*4:35+n*4]
775
776 For SVP64 the relationship for the sequential
777 numbering of elements is to the CR **fields** within
778 the CR Register, not to individual bits within the CR register.
779
780 In OpenPOWER v3.0/1, BF/BT/BA/BB are all 5 bits. The top 3 bits (0:2)
781 select one of the 8 CRs; the bottom 2 bits (3:4) select one of 4 bits
782 *in* that CR (EQ/LT/GT/SO). The numbering was determined (after 4 months of
783 analysis and research) to be as follows:
784
785 CR_index = 7-(BA>>2) # top 3 bits but BE
786 bit_index = 3-(BA & 0b11) # low 2 bits but BE
787 CR_reg = CR{CR_index} # get the CR
788 # finally get the bit from the CR.
789 CR_bit = (CR_reg & (1<<bit_index)) != 0
790
791 When it comes to applying SV, it is the CR\_reg number to which SV EXTRA2/3
792 applies, **not** the CR\_bit portion (bits 3-4):
793
794 if extra3_mode:
795 spec = EXTRA3
796 else:
797 spec = EXTRA2<<1 | 0b0
798 if spec[0]:
799 # vector constructs "BA[0:2] spec[1:2] 00 BA[3:4]"
800 return ((BA >> 2)<<6) | # hi 3 bits shifted up
801 (spec[1:2]<<4) | # to make room for these
802 (BA & 0b11) # CR_bit on the end
803 else:
804 # scalar constructs "00 spec[1:2] BA[0:4]"
805 return (spec[1:2] << 5) | BA
806
807 Thus, for example, to access a given bit for a CR in SV mode, the v3.0B
808 algorithm to determine CR\_reg is modified to as follows:
809
810 CR_index = 7-(BA>>2) # top 3 bits but BE
811 if spec[0]:
812 # vector mode, 0-124 increments of 4
813 CR_index = (CR_index<<4) | (spec[1:2] << 2)
814 else:
815 # scalar mode, 0-32 increments of 1
816 CR_index = (spec[1:2]<<3) | CR_index
817 # same as for v3.0/v3.1 from this point onwards
818 bit_index = 3-(BA & 0b11) # low 2 bits but BE
819 CR_reg = CR{CR_index} # get the CR
820 # finally get the bit from the CR.
821 CR_bit = (CR_reg & (1<<bit_index)) != 0
822
823 Note here that the decoding pattern to determine CR\_bit does not change.
824
825 Note: high-performance implementations may read/write Vectors of CRs in
826 batches of aligned 32-bit chunks (CR0-7, CR7-15). This is to greatly
827 simplify internal design. If instructions are issued where CR Vectors
828 do not start on a 32-bit aligned boundary, performance may be affected.
829
830 ## CR fields as inputs/outputs of vector operations
831
832 CRs (or, the arithmetic operations associated with them)
833 may be marked as Vectorised or Scalar. When Rc=1 in arithmetic operations that have no explicit EXTRA to cover the CR, the CR is Vectorised if the destination is Vectorised. Likewise if the destination is scalar then so is the CR.
834
835 When vectorized, the CR inputs/outputs are sequentially read/written
836 to 4-bit CR fields. Vectorised Integer results, when Rc=1, will begin
837 writing to CR8 (TBD evaluate) and increase sequentially from there.
838 This is so that:
839
840 * implementations may rely on the Vector CRs being aligned to 8. This
841 means that CRs may be read or written in aligned batches of 32 bits
842 (8 CRs per batch), for high performance implementations.
843 * scalar Rc=1 operation (CR0, CR1) and callee-saved CRs (CR2-4) are not
844 overwritten by vector Rc=1 operations except for very large VL
845 * CR-based predication, from CR32, is also not interfered with
846 (except by large VL).
847
848 However when the SV result (destination) is marked as a scalar by the
849 EXTRA field the *standard* v3.0B behaviour applies: the accompanying
850 CR when Rc=1 is written to. This is CR0 for integer operations and CR1
851 for FP operations.
852
853 Note that yes, the CR Fields are genuinely Vectorised. Unlike in SIMD VSX which
854 has a single CR (CR6) for a given SIMD result, SV Vectorised OpenPOWER
855 v3.0B scalar operations produce a **tuple** of element results: the
856 result of the operation as one part of that element *and a corresponding
857 CR element*. Greatly simplified pseudocode:
858
859 for i in range(VL):
860 # calculate the vector result of an add
861 iregs[RT+i] = iregs[RA+i] + iregs[RB+i]
862 # now calculate CR bits
863 CRs{8+i}.eq = iregs[RT+i] == 0
864 CRs{8+i}.gt = iregs[RT+i] > 0
865 ... etc
866
867 If a "cumulated" CR based analysis of results is desired (a la VSX CR6)
868 then a followup instruction must be performed, setting "reduce" mode on
869 the Vector of CRs, using cr ops (crand, crnor) to do so. This provides far
870 more flexibility in analysing vectors than standard Vector ISAs. Normal
871 Vector ISAs are typically restricted to "were all results nonzero" and
872 "were some results nonzero". The application of mapreduce to Vectorised
873 cr operations allows far more sophisticated analysis, particularly in
874 conjunction with the new crweird operations see [[sv/cr_int_predication]].
875
876 Note in particular that the use of a separate instruction in this way
877 ensures that high performance multi-issue OoO inplementations do not
878 have the computation of the cumulative analysis CR as a bottleneck and
879 hindrance, regardless of the length of VL.
880
881 Additionally,
882 SVP64 [[sv/branches]] may be used, even when the branch itself is to
883 the following instruction. The combined side-effects of CTR reduction
884 and VL truncation provide several benefits.
885
886 (see [[discussion]]. some alternative schemes are described there)
887
888 ## Rc=1 when SUBVL!=1
889
890 sub-vectors are effectively a form of Packed SIMD (length 2 to 4). Only 1 bit of
891 predicate is allocated per subvector; likewise only one CR is allocated
892 per subvector.
893
894 This leaves a conundrum as to how to apply CR computation per subvector,
895 when normally Rc=1 is exclusively applied to scalar elements. A solution
896 is to perform a bitwise OR or AND of the subvector tests. Given that
897 OE is ignored in SVP64, this field may (when available) be used to select OR or
898 AND behavior.
899
900 ### Table of CR fields
901
902 CRn is the notation used by the OpenPower spec to refer to CR field #i,
903 so FP instructions with Rc=1 write to CR1 (n=1).
904
905 CRs are not stored in SPRs: they are registers in their own right.
906 Therefore context-switching the full set of CRs involves a Vectorised
907 mfcr or mtcr, using VL=8 to do so. This is exactly as how
908 scalar OpenPOWER context-switches CRs: it is just that there are now
909 more of them.
910
911 The 64 SV CRs are arranged similarly to the way the 128 integer registers
912 are arranged. TODO a python program that auto-generates a CSV file
913 which can be included in a table, which is in a new page (so as not to
914 overwhelm this one). [[svp64/cr_names]]
915
916 # Register Profiles
917
918 Instructions are broken down by Register Profiles as listed in the
919 following auto-generated page: [[opcode_regs_deduped]]. These tables,
920 despite being auto-generated, are part of the Specification.
921
922 # SV pseudocode illilustration
923
924 ## Single-predicated Instruction
925
926 illustration of normal mode add operation: zeroing not included, elwidth
927 overrides not included. if there is no predicate, it is set to all 1s
928
929 function op_add(rd, rs1, rs2) # add not VADD!
930 int i, id=0, irs1=0, irs2=0;
931 predval = get_pred_val(FALSE, rd);
932 for (i = 0; i < VL; i++)
933 STATE.srcoffs = i # save context
934 if (predval & 1<<i) # predication uses intregs
935 ireg[rd+id] <= ireg[rs1+irs1] + ireg[rs2+irs2];
936 if (!int_vec[rd].isvec) break;
937 if (rd.isvec) { id += 1; }
938 if (rs1.isvec) { irs1 += 1; }
939 if (rs2.isvec) { irs2 += 1; }
940 if (id == VL or irs1 == VL or irs2 == VL)
941 {
942 # end VL hardware loop
943 STATE.srcoffs = 0; # reset
944 return;
945 }
946
947 This has several modes:
948
949 * RT.v = RA.v RB.v
950 * RT.v = RA.v RB.s (and RA.s RB.v)
951 * RT.v = RA.s RB.s
952 * RT.s = RA.v RB.v
953 * RT.s = RA.v RB.s (and RA.s RB.v)
954 * RT.s = RA.s RB.s
955
956 All of these may be predicated. Vector-Vector is straightfoward.
957 When one of source is a Vector and the other a Scalar, it is clear that
958 each element of the Vector source should be added to the Scalar source,
959 each result placed into the Vector (or, if the destination is a scalar,
960 only the first nonpredicated result).
961
962 The one that is not obvious is RT=vector but both RA/RB=scalar.
963 Here this acts as a "splat scalar result", copying the same result into
964 all nonpredicated result elements. If a fixed destination scalar was
965 intended, then an all-Scalar operation should be used.
966
967 See <https://bugs.libre-soc.org/show_bug.cgi?id=552>
968
969 # Assembly Annotation
970
971 Assembly code annotation is required for SV to be able to successfully
972 mark instructions as "prefixed".
973
974 A reasonable (prototype) starting point:
975
976 svp64 [field=value]*
977
978 Fields:
979
980 * ew=8/16/32 - element width
981 * sew=8/16/32 - source element width
982 * vec=2/3/4 - SUBVL
983 * mode=mr/satu/sats/crpred
984 * pred=1\<\<3/r3/~r3/r10/~r10/r30/~r30/lt/gt/le/ge/eq/ne
985
986 similar to x86 "rex" prefix.
987
988 For actual assembler:
989
990 sv.asmcode/mode.vec{N}.ew=8,sw=16,m={pred},sm={pred} reg.v, src.s
991
992 Qualifiers:
993
994 * m={pred}: predicate mask mode
995 * sm={pred}: source-predicate mask mode (only allowed in Twin-predication)
996 * vec{N}: vec2 OR vec3 OR vec4 - sets SUBVL=2/3/4
997 * ew={N}: ew=8/16/32 - sets elwidth override
998 * sw={N}: sw=8/16/32 - sets source elwidth override
999 * ff={xx}: see fail-first mode
1000 * pr={xx}: see predicate-result mode
1001 * sat{x}: satu / sats - see saturation mode
1002 * mr: see map-reduce mode
1003 * mrr: map-reduce, reverse-gear (VL-1 downto 0)
1004 * mr.svm see map-reduce with sub-vector mode
1005 * crm: see map-reduce CR mode
1006 * crm.svm see map-reduce CR with sub-vector mode
1007 * sz: predication with source-zeroing
1008 * dz: predication with dest-zeroing
1009
1010 For modes:
1011
1012 * pred-result:
1013 - pm=lt/gt/le/ge/eq/ne/so/ns
1014 - RC1 mode
1015 * fail-first
1016 - ff=lt/gt/le/ge/eq/ne/so/ns
1017 - RC1 mode
1018 * saturation:
1019 - sats
1020 - satu
1021 * map-reduce:
1022 - mr OR crm: "normal" map-reduce mode or CR-mode.
1023 - mr.svm OR crm.svm: when vec2/3/4 set, sub-vector mapreduce is enabled
1024
1025 # Parallel-reduction algorithm
1026
1027 The principle of SVP64 is that SVP64 is a fully-independent
1028 Abstraction of hardware-looping in between issue and execute phases
1029 that has no relation to the operation it issues.
1030 Additional state cannot be saved on context-switching beyond that
1031 of SVSTATE, making things slightly tricky.
1032
1033 Executable demo pseudocode, full version
1034 [here](https://git.libre-soc.org/?p=libreriscv.git;a=blob;f=openpower/sv/test_preduce.py;hb=HEAD)
1035
1036 ```
1037 [[!inline pages="openpower/sv/preduce.py" raw="yes" ]]
1038 ```
1039
1040 This algorithm works by noting when data remains in-place rather than
1041 being reduced, and referring to that alternative position on subsequent
1042 layers of reduction. It is re-entrant. If however interrupted and
1043 restored, some implementations may take longer to re-establish the
1044 context.
1045
1046 Its application by default is that:
1047
1048 * RA, FRA or BFA is the first register as the first operand
1049 (ci index offset in the above pseudocode)
1050 * RB, FRB or BFB is the second (co index offset)
1051 * RT (result) also uses ci **if RA==RT**
1052
1053 For more complex applications a REMAP Schedule must be used
1054
1055 *Programmers's note:
1056 if passed a predicate mask with only one bit set, this algorithm
1057 takes no action, similar to when a predicate mask is all zero.*
1058
1059 *Implementor's Note: many SIMD-based Parallel Reduction Algorithms are
1060 implemented in hardware with MVs that ensure lane-crossing is minimised.
1061 The mistake which would be catastrophic to SVP64 to make is to then
1062 limit the Reduction Sequence for all implementors
1063 based solely and exclusively on what one
1064 specific internal microarchitecture does.
1065 In SIMD ISAs the internal SIMD Architectural design is exposed and imposed on the programmer. Cray-style Vector ISAs on the other hand provide convenient,
1066 compact and efficient encodings of abstract concepts.*
1067 **It is the Implementor's responsibility to produce a design
1068 that complies with the above algorithm,
1069 utilising internal Micro-coding and other techniques to transparently
1070 insert micro-architectural lane-crossing Move operations
1071 if necessary or desired, to give the level of efficiency or performance
1072 required.**
1073
1074 # Element-width overrides <a name="elwidth"> </>
1075
1076 Element-width overrides are best illustrated with a packed structure
1077 union in the c programming language. The following should be taken
1078 literally, and assume always a little-endian layout:
1079
1080 typedef union {
1081 uint8_t b[];
1082 uint16_t s[];
1083 uint32_t i[];
1084 uint64_t l[];
1085 uint8_t actual_bytes[8];
1086 } el_reg_t;
1087
1088 elreg_t int_regfile[128];
1089
1090 get_polymorphed_reg(reg, bitwidth, offset):
1091 el_reg_t res;
1092 res.l = 0; // TODO: going to need sign-extending / zero-extending
1093 if bitwidth == 8:
1094 reg.b = int_regfile[reg].b[offset]
1095 elif bitwidth == 16:
1096 reg.s = int_regfile[reg].s[offset]
1097 elif bitwidth == 32:
1098 reg.i = int_regfile[reg].i[offset]
1099 elif bitwidth == 64:
1100 reg.l = int_regfile[reg].l[offset]
1101 return res
1102
1103 set_polymorphed_reg(reg, bitwidth, offset, val):
1104 if (!reg.isvec):
1105 # not a vector: first element only, overwrites high bits
1106 int_regfile[reg].l[0] = val
1107 elif bitwidth == 8:
1108 int_regfile[reg].b[offset] = val
1109 elif bitwidth == 16:
1110 int_regfile[reg].s[offset] = val
1111 elif bitwidth == 32:
1112 int_regfile[reg].i[offset] = val
1113 elif bitwidth == 64:
1114 int_regfile[reg].l[offset] = val
1115
1116 In effect the GPR registers r0 to r127 (and corresponding FPRs fp0
1117 to fp127) are reinterpreted to be "starting points" in a byte-addressable
1118 memory. Vectors - which become just a virtual naming construct - effectively
1119 overlap.
1120
1121 It is extremely important for implementors to note that the only circumstance
1122 where upper portions of an underlying 64-bit register are zero'd out is
1123 when the destination is a scalar. The ideal register file has byte-level
1124 write-enable lines, just like most SRAMs, in order to avoid READ-MODIFY-WRITE.
1125
1126 An example ADD operation with predication and element width overrides:
1127
1128  for (i = 0; i < VL; i++)
1129 if (predval & 1<<i) # predication
1130 src1 = get_polymorphed_reg(RA, srcwid, irs1)
1131 src2 = get_polymorphed_reg(RB, srcwid, irs2)
1132 result = src1 + src2 # actual add here
1133 set_polymorphed_reg(RT, destwid, ird, result)
1134 if (!RT.isvec) break
1135 if (RT.isvec)  { id += 1; }
1136 if (RA.isvec)  { irs1 += 1; }
1137 if (RB.isvec)  { irs2 += 1; }
1138
1139 Thus it can be clearly seen that elements are packed by their
1140 element width, and the packing starts from the source (or destination)
1141 specified by the instruction.
1142
1143 # Twin (implicit) result operations
1144
1145 Some operations in the Power ISA already target two 64-bit scalar
1146 registers: `lq` for example, and LD with update.
1147 Some mathematical algorithms are more
1148 efficient when there are two outputs rather than one, providing
1149 feedback loops between elements (the most well-known being add with
1150 carry). 64-bit multiply
1151 for example actually internally produces a 128 bit result, which clearly
1152 cannot be stored in a single 64 bit register. Some ISAs recommend
1153 "macro op fusion": the practice of setting a convention whereby if
1154 two commonly used instructions (mullo, mulhi) use the same ALU but
1155 one selects the low part of an identical operation and the other
1156 selects the high part, then optimised micro-architectures may
1157 "fuse" those two instructions together, using Micro-coding techniques,
1158 internally.
1159
1160 The practice and convention of macro-op fusion however is not compatible
1161 with SVP64 Horizontal-First, because Horizontal Mode may only
1162 be applied to a single instruction at a time, and SVP64 is based on
1163 the principle of strict Program Order even at the element
1164 level. Thus it becomes
1165 necessary to add explicit more complex single instructions with
1166 more operands than would normally be seen in the average RISC ISA
1167 (3-in, 2-out, in some cases). If it
1168 was not for Power ISA already having LD/ST with update as well as
1169 Condition Codes and `lq` this would be hard to justify.
1170
1171 With limited space in the `EXTRA` Field, and Power ISA opcodes
1172 being only 32 bit, 5 operands is quite an ask. `lq` however sets
1173 a precedent: `RTp` stands for "RT pair". In other words the result
1174 is stored in RT and RT+1. For Scalar operations, following this
1175 precedent is perfectly reasonable. In Scalar mode,
1176 `madded` therefore stores the two halves of the 128-bit multiply
1177 into RT and RT+1.
1178
1179 What, then, of `sv.madded`? If the destination is hard-coded to
1180 RT and RT+1 the instruction is not useful when Vectorised because
1181 the output will be overwritten on the next element. To solve this
1182 is easy: define the destination registers as RT and RT+MAXVL
1183 respectively. This makes it easy for compilers to statically allocate
1184 registers even when VL changes dynamically.
1185
1186 Bear in mind that both RT and RT+MAXVL are starting points for Vectors,
1187 and bear in mind that element-width overrides still have to be taken
1188 into consideration, the starting point for the implicit destination
1189 is best illustrated in pseudocode:
1190
1191 # demo of madded
1192  for (i = 0; i < VL; i++)
1193 if (predval & 1<<i) # predication
1194 src1 = get_polymorphed_reg(RA, srcwid, irs1)
1195 src2 = get_polymorphed_reg(RB, srcwid, irs2)
1196 src2 = get_polymorphed_reg(RC, srcwid, irs3)
1197 result = src1*src2 + src2
1198 destmask = (2<<destwid)-1
1199 # store two halves of result, both start from RT.
1200 set_polymorphed_reg(RT, destwid, ird , result&destmask)
1201 set_polymorphed_reg(RT, destwid, ird+MAXVL, result>>destwid)
1202 if (!RT.isvec) break
1203 if (RT.isvec)  { id += 1; }
1204 if (RA.isvec)  { irs1 += 1; }
1205 if (RB.isvec)  { irs2 += 1; }
1206 if (RC.isvec)  { irs3 += 1; }
1207
1208 The significant part here is that the second half is stored
1209 starting not from RT+MAXVL at all: it is the *element* index
1210 that is offset by MAXVL, both halves actually starting from RT.
1211 If VL is 3, MAXVL is 5, RT is 1, and dest elwidth is 32 then the elements
1212 RT0 to RT2 are stored:
1213
1214 0..31 32..63
1215 r0 unchanged unchanged
1216 r1 RT0.lo RT1.lo
1217 r2 RT2.lo unchanged
1218 r3 unchanged RT0.hi
1219 r4 RT1.hi RT2.hi
1220 r5 unchanged unchanged
1221
1222 Note that all of the LO halves start from r1, but that the HI halves
1223 start from half-way into r3. The reason is that with MAXVL bring
1224 5 and elwidth being 32, this is the 5th element
1225 offset (in 32 bit quantities) counting from r1.
1226
1227 *Programmer's note: accessing registers that have been placed
1228 starting on a non-contiguous boundary (half-way along a scalar
1229 register) can be inconvenient: REMAP can provide an offset but
1230 it requires extra instructions to set up. A simple solution
1231 is to ensure that MAXVL is rounded up such that the Vector
1232 ends cleanly on a contiguous register boundary. MAXVL=6 in
1233 the above example would achieve that*
1234
1235 Additional DRAFT Scalar instructions in 3-in 2-out form
1236 with an implicit 2nd destination:
1237
1238 * [[isa/svfixedarith]]
1239 * [[isa/svfparith]]
1240