-
Notifications
You must be signed in to change notification settings - Fork 30
Expand file tree
/
Copy pathLeopard2Plan.cpp
More file actions
1813 lines (1694 loc) · 62.9 KB
/
Copy pathLeopard2Plan.cpp
File metadata and controls
1813 lines (1694 loc) · 62.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright (c) 2017 Christopher A. Taylor. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of Leopard-RS nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
#include "Leopard2Plan.h"
#include "Leopard2Backend.h"
#include <string.h>
#include <utility>
namespace {
using leopard2_internal::PrunedTransformOperation;
static bool IsPowerOfTwo(uint32_t value)
{
return value != 0 && (value & (value - 1)) == 0;
}
static void BuildRawPrunedOperations(
uint32_t start,
uint32_t size,
uint32_t coset,
bool inverse,
leopard2_internal::PrunedMultiplierLogProvider multiplier_log,
const void* multiplier_context,
std::vector<PrunedTransformOperation>& operations)
{
if (size == 1)
return;
const uint32_t half = size >> 1;
if (size == 2)
{
const uint16_t log_m = multiplier_log(
multiplier_context, coset + half);
const PrunedTransformOperation operation = {
start,
start + 1,
log_m,
0
};
operations.push_back(operation);
return;
}
// Group every pair of transform layers in the exact order consumed by
// Butterfly4. Operations for different offsets and disjoint child
// subspaces commute, so this is the same radix-2 DAG as the historical
// root/child traversal with complete two-layer regions made contiguous.
const uint32_t quarter = size >> 2;
const uint16_t log_m01 = multiplier_log(
multiplier_context, coset + quarter);
const uint16_t log_m23 = multiplier_log(
multiplier_context, coset + half + quarter);
const uint16_t log_m02 = multiplier_log(
multiplier_context, coset + half);
if (inverse)
{
BuildRawPrunedOperations(
start, quarter, coset, inverse,
multiplier_log, multiplier_context, operations);
BuildRawPrunedOperations(
start + quarter, quarter, coset + quarter, inverse,
multiplier_log, multiplier_context, operations);
BuildRawPrunedOperations(
start + half, quarter, coset + half, inverse,
multiplier_log, multiplier_context, operations);
BuildRawPrunedOperations(
start + half + quarter, quarter, coset + half + quarter,
inverse, multiplier_log, multiplier_context, operations);
}
for (uint32_t offset = 0; offset < quarter; ++offset)
{
const uint32_t value0 = start + offset;
const uint32_t value1 = value0 + quarter;
const uint32_t value2 = value0 + half;
const uint32_t value3 = value2 + quarter;
if (inverse)
{
const PrunedTransformOperation grouped[] = {
{ value0, value1, log_m01, 0 },
{ value2, value3, log_m23, 0 },
{ value0, value2, log_m02, 0 },
{ value1, value3, log_m02, 0 }
};
operations.insert(operations.end(), grouped, grouped + 4);
}
else
{
const PrunedTransformOperation grouped[] = {
{ value0, value2, log_m02, 0 },
{ value1, value3, log_m02, 0 },
{ value0, value1, log_m01, 0 },
{ value2, value3, log_m23, 0 }
};
operations.insert(operations.end(), grouped, grouped + 4);
}
}
if (!inverse)
{
BuildRawPrunedOperations(
start, quarter, coset, inverse,
multiplier_log, multiplier_context, operations);
BuildRawPrunedOperations(
start + quarter, quarter, coset + quarter, inverse,
multiplier_log, multiplier_context, operations);
BuildRawPrunedOperations(
start + half, quarter, coset + half, inverse,
multiplier_log, multiplier_context, operations);
BuildRawPrunedOperations(
start + half + quarter, quarter, coset + half + quarter,
inverse, multiplier_log, multiplier_context, operations);
}
}
static bool CoefficientAIsNonzero(bool inverse, bool multiplier_one)
{
return !inverse || !multiplier_one;
}
static bool CoefficientAIsOne(bool inverse, bool multiplier_zero)
{
return !inverse || multiplier_zero;
}
static bool CoefficientDIsNonzero(bool inverse, bool multiplier_one)
{
return inverse || !multiplier_one;
}
static bool CoefficientDIsOne(bool inverse, bool multiplier_zero)
{
return inverse || multiplier_zero;
}
struct PrunedExecutionOps
{
leopard::backend::FixedMultiply multiply;
leopard::backend::FixedMultiply multiply_add;
leopard::backend::Butterfly2 butterfly;
leopard::backend::Butterfly4 butterfly_four;
leopard::backend::FFTButterfly2Out butterfly_out;
leopard::backend::IFFTButterfly2Xor inverse_butterfly_xor;
};
struct FusedFourMatch
{
uint32_t value0;
uint32_t value1;
uint32_t value2;
uint32_t value3;
uint16_t multiplier_log01;
uint16_t multiplier_log23;
uint16_t multiplier_log02;
};
static bool MatchFusedFour(
const std::vector<leopard2_internal::PrunedTransformOperation>& operations,
size_t start,
bool inverse,
FusedFourMatch& match)
{
if (start > operations.size() || operations.size() - start < 4)
return false;
const leopard2_internal::PrunedTransformOperation& first =
operations[start];
const leopard2_internal::PrunedTransformOperation& second =
operations[start + 1];
const leopard2_internal::PrunedTransformOperation& third =
operations[start + 2];
const leopard2_internal::PrunedTransformOperation& fourth =
operations[start + 3];
const uint8_t complete =
leopard2_internal::PrunedLiveX |
leopard2_internal::PrunedLiveY |
leopard2_internal::PrunedNeedX |
leopard2_internal::PrunedNeedY;
if ((first.flags & complete) != complete ||
(second.flags & complete) != complete ||
(third.flags & complete) != complete ||
(fourth.flags & complete) != complete)
return false;
if (inverse)
{
match.value0 = first.x;
match.value1 = first.y;
match.value2 = second.x;
match.value3 = second.y;
match.multiplier_log01 = first.multiplier_log;
match.multiplier_log23 = second.multiplier_log;
match.multiplier_log02 = third.multiplier_log;
if (third.x != match.value0 || third.y != match.value2 ||
fourth.x != match.value1 || fourth.y != match.value3 ||
fourth.multiplier_log != match.multiplier_log02)
return false;
}
else
{
match.value0 = first.x;
match.value2 = first.y;
match.value1 = second.x;
match.value3 = second.y;
match.multiplier_log02 = first.multiplier_log;
match.multiplier_log01 = third.multiplier_log;
match.multiplier_log23 = fourth.multiplier_log;
if (second.multiplier_log != match.multiplier_log02 ||
third.x != match.value0 || third.y != match.value1 ||
fourth.x != match.value2 || fourth.y != match.value3)
return false;
}
return match.value0 != match.value1 &&
match.value0 != match.value2 &&
match.value0 != match.value3 &&
match.value1 != match.value2 &&
match.value1 != match.value3 &&
match.value2 != match.value3;
}
static bool ExecutePrunedOperation(
const leopard::backend::Ops& ops,
const PrunedExecutionOps& selected,
bool inverse,
uint16_t zero_multiplier_log,
uint64_t byte_count,
const leopard2_internal::PrunedTransformOperation& operation,
void* x,
void* y)
{
const uint8_t flags = operation.flags;
const bool live_x = 0 != (flags & leopard2_internal::PrunedLiveX);
const bool live_y = 0 != (flags & leopard2_internal::PrunedLiveY);
const bool write_x = 0 != (flags & leopard2_internal::PrunedWriteX);
const bool write_y = 0 != (flags & leopard2_internal::PrunedWriteY);
const uint16_t log_m = operation.multiplier_log;
const bool multiplier_zero = log_m == zero_multiplier_log;
const bool multiplier_one = log_m == 0;
if (live_x && live_y)
{
// A retained row may leave its peer dead, but running the complete
// two-way butterfly is still exact and lets the mature backend reuse
// its one fixed product. Zero and one avoid table lookup entirely.
if (multiplier_zero)
{
ops.xor_memory(y, x, byte_count);
}
else if (multiplier_one)
{
if (inverse)
{
ops.xor_memory(y, x, byte_count);
ops.xor_memory(x, y, byte_count);
}
else
{
ops.xor_memory(x, y, byte_count);
ops.xor_memory(y, x, byte_count);
}
}
else
{
selected.butterfly(x, y, log_m, byte_count);
}
return true;
}
if (live_x)
{
if (!inverse)
{
// [x, 0] -> [x, x].
if (write_y)
memcpy(y, x, static_cast<size_t>(byte_count));
return true;
}
// [x, 0] -> [(m + 1) x, x]. The dead y slot safely preserves x
// while the in-place multiply-add updates the first row.
if (write_y || (write_x && !multiplier_zero))
memcpy(y, x, static_cast<size_t>(byte_count));
if (write_x && !multiplier_zero)
selected.multiply_add(x, y, log_m, byte_count);
return true;
}
if (live_y)
{
// Forward: [0, y] -> [m y, (m + 1) y].
// Inverse: [0, y] -> [m y, y].
// If only the second forward row is needed, x remains available as a
// dead temporary so the direct matrix row still needs one product.
if (write_x || (!inverse && write_y))
{
if (multiplier_zero)
memset(x, 0, static_cast<size_t>(byte_count));
else if (multiplier_one)
memcpy(x, y, static_cast<size_t>(byte_count));
else
selected.multiply(x, y, log_m, byte_count);
}
if (!inverse && write_y)
ops.xor_memory(y, x, byte_count);
return true;
}
return !write_x && !write_y;
}
static void ExecutePrunedInverseOperationAccumulate(
const leopard::backend::Ops& ops,
const PrunedExecutionOps& selected,
uint16_t zero_multiplier_log,
uint64_t byte_count,
const leopard2_internal::PrunedTransformOperation& operation,
const void* x,
const void* y,
void* x_accumulator,
void* y_accumulator)
{
const uint8_t flags = operation.flags;
const bool live_x =
0 != (flags & leopard2_internal::PrunedLiveX);
const bool live_y =
0 != (flags & leopard2_internal::PrunedLiveY);
const bool need_x =
0 != (flags & leopard2_internal::PrunedNeedX);
const bool need_y =
0 != (flags & leopard2_internal::PrunedNeedY);
const uint16_t log_m = operation.multiplier_log;
// The common dense boundary consumes both rows with one product. The
// sentinel denotes m=0 and is intentionally kept out of backend table
// lookup, while retaining the inverse butterfly's XOR edge.
if (live_x && live_y && need_x && need_y)
{
if (log_m == zero_multiplier_log)
{
ops.xor_memory(x_accumulator, x, byte_count);
ops.xor_memory_2to1(y_accumulator, x, y, byte_count);
}
else
{
selected.inverse_butterfly_xor(
x, y, x_accumulator, y_accumulator, log_m, byte_count);
}
return;
}
// y' = x + y. Structural liveness makes the missing terms exact zero;
// no temporary materialization is needed for either sparse case.
if (need_y)
{
if (live_x && live_y)
ops.xor_memory_2to1(y_accumulator, x, y, byte_count);
else if (live_x)
ops.xor_memory(y_accumulator, x, byte_count);
else if (live_y)
ops.xor_memory(y_accumulator, y, byte_count);
}
if (!need_x)
return;
// x' = x + m * (x + y). Specializing m=0 and m=1 avoids tables and,
// importantly, also covers identity rows that the compact in-place
// schedule deliberately omits.
if (log_m == zero_multiplier_log)
{
if (live_x)
ops.xor_memory(x_accumulator, x, byte_count);
return;
}
if (log_m == 0)
{
if (live_y)
ops.xor_memory(x_accumulator, y, byte_count);
return;
}
if (live_x)
{
ops.xor_memory(x_accumulator, x, byte_count);
selected.multiply_add(
x_accumulator, x, log_m, byte_count);
}
if (live_y)
selected.multiply_add(x_accumulator, y, log_m, byte_count);
}
static size_t SparseButterflyCountUnchecked(uint32_t size)
{
size_t log2_size = 0;
for (uint32_t value = size; value > 1; value >>= 1)
++log2_size;
return static_cast<size_t>(size >> 1) * log2_size;
}
static bool PackedBit(
const uint8_t* bits,
size_t bit_count,
size_t index)
{
return index < bit_count &&
0 != (bits[index >> 3] & static_cast<uint8_t>(1u << (index & 7u)));
}
static void AssignPackedBit(uint8_t* bits, size_t index, bool value)
{
const uint8_t mask = static_cast<uint8_t>(1u << (index & 7u));
if (value)
bits[index >> 3] |= mask;
else
bits[index >> 3] &= static_cast<uint8_t>(~mask);
}
static uint8_t SparseOperationMask(
const uint8_t* masks,
size_t operation_count,
size_t index)
{
if (index >= operation_count)
return 0;
return static_cast<uint8_t>(
(masks[index >> 2] >> ((index & 3U) * 2U)) & 3U);
}
static void SetSparseOperationMask(
uint8_t* masks,
size_t index,
uint8_t value)
{
const unsigned shift = static_cast<unsigned>((index & 3U) * 2U);
const uint8_t clear = static_cast<uint8_t>(~(3U << shift));
masks[index >> 2] = static_cast<uint8_t>(
(masks[index >> 2] & clear) | (value << shift));
}
struct SparseCompileContext
{
uint16_t zero_multiplier_log;
uint8_t* needed;
size_t needed_count;
uint8_t* operation_masks;
size_t operation_index;
leopard2_internal::PrunedMultiplierLogProvider multiplier_log;
const void* multiplier_context;
leopard2_internal::SparseForwardPlanStats* stats;
bool valid;
};
static uint16_t SparseMultiplier(
SparseCompileContext& context,
uint32_t storage_index)
{
const uint16_t result = context.multiplier_log(
context.multiplier_context, storage_index);
if (result > context.zero_multiplier_log)
context.valid = false;
return result;
}
static void CompileSparseOperationReverse(
SparseCompileContext& context,
uint32_t x,
uint32_t y,
uint16_t multiplier_log)
{
if (!context.valid || context.operation_index == 0)
{
context.valid = false;
return;
}
const size_t operation = --context.operation_index;
const bool need_x = PackedBit(context.needed, context.needed_count, x);
const bool need_y = PackedBit(context.needed, context.needed_count, y);
if (!need_x && !need_y)
return;
SetSparseOperationMask(context.operation_masks, operation,
static_cast<uint8_t>((need_x ? 1U : 0U) | (need_y ? 2U : 0U)));
++context.stats->retained_butterfly_count;
if (need_x != need_y)
++context.stats->one_output_butterflies;
const bool multiplier_zero =
multiplier_log == context.zero_multiplier_log;
const bool multiplier_one = multiplier_log == 0;
// Forward butterfly rows are x + m*y and x + (m+1)*y.
AssignPackedBit(context.needed, x, need_x || need_y);
AssignPackedBit(context.needed, y,
(need_x && !multiplier_zero) ||
(need_y && !multiplier_one));
}
static void CompileSparseNodeReverse(
SparseCompileContext& context,
uint32_t start,
uint32_t size,
uint32_t coset)
{
if (!context.valid)
return;
if (size == 1)
return;
if (size == 2)
{
CompileSparseOperationReverse(context, start, start + 1,
SparseMultiplier(context, coset + 1));
return;
}
const uint32_t quarter = size >> 2;
const uint32_t half = size >> 1;
const uint16_t multiplier01 = SparseMultiplier(
context, coset + quarter);
const uint16_t multiplier23 = SparseMultiplier(
context, coset + half + quarter);
const uint16_t multiplier02 = SparseMultiplier(
context, coset + half);
// Reverse the exact forward traversal: four child transforms followed by
// the grouped two-layer butterflies at this node.
CompileSparseNodeReverse(context,
start + half + quarter, quarter, coset + half + quarter);
CompileSparseNodeReverse(context,
start + half, quarter, coset + half);
CompileSparseNodeReverse(context,
start + quarter, quarter, coset + quarter);
CompileSparseNodeReverse(context,
start, quarter, coset);
for (uint32_t offset = quarter; offset-- > 0;)
{
const uint32_t value0 = start + offset;
const uint32_t value1 = value0 + quarter;
const uint32_t value2 = value0 + half;
const uint32_t value3 = value2 + quarter;
CompileSparseOperationReverse(
context, value2, value3, multiplier23);
CompileSparseOperationReverse(
context, value0, value1, multiplier01);
CompileSparseOperationReverse(
context, value1, value3, multiplier02);
CompileSparseOperationReverse(
context, value0, value2, multiplier02);
}
}
struct SparseCountContext
{
const uint8_t* operation_masks;
size_t operation_count;
size_t operation_index;
size_t fused_four_groups;
};
static void CountSparseFusedNode(
SparseCountContext& context,
uint32_t size)
{
if (size == 1)
return;
if (size == 2)
{
++context.operation_index;
return;
}
const uint32_t quarter = size >> 2;
for (uint32_t offset = 0; offset < quarter; ++offset)
{
bool complete = true;
for (unsigned operation = 0; operation < 4; ++operation)
complete = complete && SparseOperationMask(
context.operation_masks, context.operation_count,
context.operation_index + operation) == 3;
if (complete)
++context.fused_four_groups;
context.operation_index += 4;
}
CountSparseFusedNode(context, quarter);
CountSparseFusedNode(context, quarter);
CountSparseFusedNode(context, quarter);
CountSparseFusedNode(context, quarter);
}
struct SparseExecuteContext
{
const leopard::backend::Ops* ops;
PrunedExecutionOps selected;
uint16_t zero_multiplier_log;
uint64_t byte_count;
const uint8_t* operation_masks;
size_t operation_count;
size_t operation_index;
uint32_t skipped_distance;
leopard2_internal::PrunedMultiplierLogProvider multiplier_log;
const void* multiplier_context;
void** work;
bool valid;
};
static uint16_t SparseMultiplier(
SparseExecuteContext& context,
uint32_t storage_index)
{
const uint16_t result = context.multiplier_log(
context.multiplier_context, storage_index);
if (result > context.zero_multiplier_log)
context.valid = false;
return result;
}
static bool ExecuteSparseOperation(
SparseExecuteContext& context,
size_t operation,
uint32_t x,
uint32_t y,
uint16_t multiplier_log)
{
const uint8_t output_mask = SparseOperationMask(
context.operation_masks, context.operation_count, operation);
if (output_mask == 0 || y - x == context.skipped_distance)
return true;
const bool multiplier_zero =
multiplier_log == context.zero_multiplier_log;
const bool multiplier_one = multiplier_log == 0;
void* const x_output = context.work[x];
void* const y_output = context.work[y];
if (output_mask == 3)
{
if (multiplier_zero)
context.ops->xor_memory(y_output, x_output, context.byte_count);
else if (multiplier_one)
{
context.ops->xor_memory(x_output, y_output, context.byte_count);
context.ops->xor_memory(y_output, x_output, context.byte_count);
}
else
context.selected.butterfly(
x_output, y_output, multiplier_log, context.byte_count);
return true;
}
if (output_mask == 1)
{
// x' = x + m*y. In particular m=0 is an identity and performs no
// write to either row.
if (multiplier_zero)
return true;
if (multiplier_one)
context.ops->xor_memory(x_output, y_output, context.byte_count);
else
context.selected.multiply_add(
x_output, y_output, multiplier_log, context.byte_count);
return true;
}
// y' = x + (m+1)*y. multiply_add supports destination==source in every
// qualified backend: each vector/scalar lane is loaded before it is stored.
if (multiplier_zero)
context.ops->xor_memory(y_output, x_output, context.byte_count);
else if (multiplier_one)
memcpy(y_output, x_output, static_cast<size_t>(context.byte_count));
else
{
context.selected.multiply_add(
y_output, y_output, multiplier_log, context.byte_count);
context.ops->xor_memory(y_output, x_output, context.byte_count);
}
return true;
}
static bool ExecuteSparseOperationFromSources(
SparseExecuteContext& context,
size_t operation,
uint32_t x,
uint32_t y,
uint16_t multiplier_log,
void* const* source)
{
const uint8_t output_mask = SparseOperationMask(
context.operation_masks, context.operation_count, operation);
if (output_mask == 0)
return true;
const bool multiplier_zero =
multiplier_log == context.zero_multiplier_log;
const bool multiplier_one = multiplier_log == 0;
const void* const x_source = source[x];
const void* const y_source = source[y];
void* const x_output = context.work[x];
void* const y_output = context.work[y];
const size_t bytes = static_cast<size_t>(context.byte_count);
if (output_mask == 3)
{
if (!multiplier_zero)
{
context.selected.butterfly_out(
x_source, y_source, x_output, y_output,
multiplier_log, context.byte_count);
return true;
}
memcpy(x_output, x_source, bytes);
memcpy(y_output, y_source, bytes);
context.ops->xor_memory(y_output, x_source, context.byte_count);
return true;
}
if (output_mask == 1)
{
if (multiplier_zero)
memcpy(x_output, x_source, bytes);
else if (multiplier_one)
{
memcpy(x_output, x_source, bytes);
context.ops->xor_memory(x_output, y_source, context.byte_count);
}
else
{
context.selected.multiply(
x_output, y_source, multiplier_log, context.byte_count);
context.ops->xor_memory(x_output, x_source, context.byte_count);
}
return true;
}
if (multiplier_one)
memcpy(y_output, x_source, bytes);
else
{
memcpy(y_output, y_source, bytes);
if (!multiplier_zero)
context.selected.multiply_add(
y_output, y_source, multiplier_log, context.byte_count);
context.ops->xor_memory(y_output, x_source, context.byte_count);
}
return true;
}
static void ExecuteSparseNode(
SparseExecuteContext& context,
uint32_t start,
uint32_t size,
uint32_t coset)
{
if (!context.valid)
return;
if (size == 1)
return;
if (size == 2)
{
const size_t operation = context.operation_index++;
const uint16_t multiplier = SparseMultiplier(context, coset + 1);
if (context.valid)
ExecuteSparseOperation(
context, operation, start, start + 1, multiplier);
return;
}
const uint32_t quarter = size >> 2;
const uint32_t half = size >> 1;
const uint16_t multiplier01 = SparseMultiplier(
context, coset + quarter);
const uint16_t multiplier23 = SparseMultiplier(
context, coset + half + quarter);
const uint16_t multiplier02 = SparseMultiplier(
context, coset + half);
if (!context.valid)
return;
for (uint32_t offset = 0; offset < quarter; ++offset)
{
const uint32_t value0 = start + offset;
const uint32_t value1 = value0 + quarter;
const uint32_t value2 = value0 + half;
const uint32_t value3 = value2 + quarter;
const size_t first = context.operation_index;
const bool skipped = half == context.skipped_distance;
bool complete = !skipped;
for (unsigned operation = 0; operation < 4; ++operation)
complete = complete && SparseOperationMask(
context.operation_masks, context.operation_count,
first + operation) == 3;
if (complete)
{
context.selected.butterfly_four(
context.work[value0], context.work[value1],
context.work[value2], context.work[value3],
multiplier01, multiplier23, multiplier02,
context.byte_count);
}
else
{
ExecuteSparseOperation(context, first, value0, value2,
multiplier02);
ExecuteSparseOperation(context, first + 1, value1, value3,
multiplier02);
ExecuteSparseOperation(context, first + 2, value0, value1,
multiplier01);
ExecuteSparseOperation(context, first + 3, value2, value3,
multiplier23);
}
context.operation_index += 4;
}
ExecuteSparseNode(context, start, quarter, coset);
ExecuteSparseNode(context,
start + quarter, quarter, coset + quarter);
ExecuteSparseNode(context,
start + half, quarter, coset + half);
ExecuteSparseNode(context,
start + half + quarter, quarter, coset + half + quarter);
}
static bool ExecuteSparseRootFromSources(
SparseExecuteContext& context,
uint32_t size,
uint32_t shift,
void* const* source)
{
const uint32_t half = size >> 1;
if (size == 2)
{
const uint16_t multiplier = SparseMultiplier(context, shift + 1);
if (!context.valid)
return false;
return ExecuteSparseOperationFromSources(
context, 0, 0, 1, multiplier, source);
}
const uint32_t quarter = size >> 2;
const uint16_t multiplier = SparseMultiplier(context, shift + half);
if (!context.valid)
return false;
for (uint32_t offset = 0; offset < quarter; ++offset)
{
const uint32_t pairs[][2] = {
{ offset, offset + half },
{ offset + quarter, offset + half + quarter }
};
for (unsigned pair = 0; pair < 2; ++pair)
{
const size_t operation = static_cast<size_t>(offset) * 4 + pair;
const uint32_t x = pairs[pair][0];
const uint32_t y = pairs[pair][1];
if (!ExecuteSparseOperationFromSources(
context, operation, x, y, multiplier, source))
return false;
}
}
return context.valid;
}
} // namespace
namespace leopard2_internal {
size_t SparseForwardButterflyCount(uint32_t transform_size)
{
if (!IsPowerOfTwo(transform_size) || transform_size < 2 ||
transform_size > 65536U)
return 0;
return SparseButterflyCountUnchecked(transform_size);
}
size_t SparseForwardRetainedBytes(uint32_t transform_size)
{
const size_t butterflies = SparseForwardButterflyCount(transform_size);
return butterflies == 0 ? 0 : (butterflies + 3U) / 4U;
}
size_t SparseForwardDependencyBytes(uint32_t transform_size)
{
if (!IsPowerOfTwo(transform_size) || transform_size < 2 ||
transform_size > 65536U)
return 0;
return (static_cast<size_t>(transform_size) + 7U) / 8U;
}
size_t CountSparseForwardRetainedButterflies(
uint32_t transform_size,
const uint8_t* operation_masks,
size_t retained_bytes)
{
const size_t butterflies = SparseForwardButterflyCount(transform_size);
if (butterflies == 0 || !operation_masks ||
retained_bytes != SparseForwardRetainedBytes(transform_size))
return 0;
size_t result = 0;
for (size_t i = 0; i < butterflies; ++i)
if (SparseOperationMask(operation_masks, butterflies, i) != 0)
++result;
return result;
}
size_t PrefixForwardButterflyCount(
uint32_t transform_size,
uint32_t requested_prefix)
{
if (!IsPowerOfTwo(transform_size) || transform_size < 2 ||
transform_size > 65536U || requested_prefix > transform_size)
return 0;
size_t result = 0;
uint32_t dist4 = transform_size;
uint32_t dist = transform_size >> 2;
for (; dist != 0; dist4 = dist, dist >>= 2)
{
for (uint32_t start = 0;
start < requested_prefix;
start += dist4)
result += static_cast<size_t>(dist) * 4U;
}
if (dist4 == 2)
result += (static_cast<size_t>(requested_prefix) + 1U) / 2U;
return result;
}
bool CompileSparseForwardPlan(
uint32_t field_order,
uint16_t zero_multiplier_log,
uint32_t transform_size,
uint32_t shift,
uint8_t* dependency_workspace,
size_t dependency_bytes,
uint8_t* operation_masks,
size_t retained_bytes,
PrunedMultiplierLogProvider multiplier_log,
const void* multiplier_context,
SparseForwardPlanStats& stats)
{
stats = SparseForwardPlanStats();
const size_t full_count = SparseForwardButterflyCount(transform_size);
const size_t expected_retained_bytes =
SparseForwardRetainedBytes(transform_size);
const size_t expected_dependency_bytes =
SparseForwardDependencyBytes(transform_size);
if (!IsPowerOfTwo(field_order) || field_order > 65536U ||
static_cast<uint32_t>(zero_multiplier_log) + 1U != field_order ||
full_count == 0 || transform_size > field_order ||
shift > field_order - transform_size ||
(shift & (transform_size - 1U)) != 0 ||
!dependency_workspace || dependency_bytes != expected_dependency_bytes ||
!operation_masks || retained_bytes != expected_retained_bytes ||
!multiplier_log || !multiplier_context)
return false;
memset(operation_masks, 0, retained_bytes);
SparseForwardPlanStats candidate;
candidate.full_butterfly_count = full_count;
SparseCompileContext context = {
zero_multiplier_log,
dependency_workspace,
transform_size,
operation_masks,
full_count,
multiplier_log,
multiplier_context,
&candidate,
true
};
CompileSparseNodeReverse(context, 0, transform_size, shift);
if (!context.valid || context.operation_index != 0)
return false;
SparseCountContext count = {
operation_masks,
full_count,
0,
0
};
CountSparseFusedNode(count, transform_size);
if (count.operation_index != full_count)
return false;
candidate.fused_four_groups = count.fused_four_groups;