SSE support (#60)

* Working sse butterfly4, but slow * Some tweaks, not helping * Try some tweaks * Use only sse and sse2 * WIP sse butterflies * Add missing file * More butterflies * First version of sse radix4 * Some cleanup * Split sse mod off * Separate macros * First 32bit sse radix4 * Improve radix4 * SSE 64-bit butterfly len 32 * Disable some debug printing * Add sse bf32 len 32, clean up comments * Speed up sse radix4 * Some cleanup * Format * Add sse butterfly 3 * Add benches for comparison * Remove some dummy debug tests * Add comparison bench * Do double fft4s for f32 radix4 * Do four bf4s in radix4 * Change confusing single and double in function names * Change confusing single and double in function names * Separate f32 and f64 sse butterfly boilerplate macros * Column butterflies WIP * fixed radix4 * More work on butterflies * Small improvements to radix4 * Tool to make butterflies * Fixed sse bf generation tool * Separate file for autogenerated butterflies * Complete sse 64bit butterflies * Add more butterflys, tune radix4 * butterfly 23 * butterfly 29 * Finish the long sse butterflies * Add hardcoded short mixed radix and good thomas * Lenght 6 bf ready * Final butterflies * Fix warnings * Working sse butterfly4, but slow * Some tweaks, not helping * Try some tweaks * Use only sse and sse2 * WIP sse butterflies * Add missing file * More butterflies * First version of sse radix4 * Some cleanup * Split sse mod off * Separate macros * First 32bit sse radix4 * Improve radix4 * SSE 64-bit butterfly len 32 * Disable some debug printing * Add sse bf32 len 32, clean up comments * Speed up sse radix4 * Some cleanup * Format * Add sse butterfly 3 * Add benches for comparison * Remove some dummy debug tests * Add comparison bench * Do double fft4s for f32 radix4 * Do four bf4s in radix4 * Change confusing single and double in function names * Change confusing single and double in function names * Separate f32 and f64 sse butterfly boilerplate macros * Column butterflies WIP * fixed radix4 * More work on butterflies * Small improvements to radix4 * Tool to make butterflies * Fixed sse bf generation tool * Separate file for autogenerated butterflies * Complete sse 64bit butterflies * Add more butterflys, tune radix4 * butterfly 23 * butterfly 29 * Finish the long sse butterflies * Add hardcoded short mixed radix and good thomas * Lenght 6 bf ready * Final butterflies * Fix warnings * Rebase on master * Small cleanup, format * Try to use two butterflies in mixed radix * Clean up, update docs * Change name from invert to negate * Fix typos in function descriptions * Naming changes to follow avx * Fix typos in comments * Add SseVector and SseVectorMut traits * Update and simplify some f32 sse butterflies * Finish manual butterflies * Some cleaning up * Update to sse4.1 * Macros for unrolling some loops * Use chunks_exact to speed up sse radix4 * Update 64bit prime butterflies * WIP updating 32-bit prime butterflies * WIP updating 32-bit prime butterflies * Use macros for calculating simd sums * Clean up bf11 * General calc macro * Update script and allprime sse butterflies * Format * Clean up comments * Clean up comments * Replace dual with parallel in function names * Format * Add sse feature, update readme * Clean up function names, use scalar radix4 shuffler * Cleanup following review * Clean up and simplify sse benches * Minor cleanup * Typos in docs * One last sweep for references to SSE3 * Added SSE feature flag documentation to lib.rs Co-authored-by: Elliott Mahler <join.together@gmail.com>
ejmahler · Apr 15, 2021 · 1f72b41 · 1f72b41
1 parent f017a41
commit 1f72b41
Show file tree

Hide file tree

Showing 22 changed files with 13,622 additions and 12 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -13,11 +13,17 @@ categories = ["algorithms", "compression", "multimedia::encoding", "science"]
 license = "MIT OR Apache-2.0"
 
 [features]
-default = ["avx"]
+default = ["avx", "sse"]
 
-# On x86_64, the "avx" feature enables compilation of AVX-acclerated code. Enabling it improves performance if the client CPU supports AVX, while disabling it reduces compile time and binary size.
-# On every other platform, this feature does nothing, and RustFFT will behave like it's not set.
+# On x86_64, the "avx" feature enables compilation of AVX-acclerated code. 
+# Similarly, the "sse" feature enables SSE-accelerated code. 
+# Enabling these improves performance if the client CPU supports AVX or SSE, while disabling them reduces compile time and binary size.
+# If both are enabled, RustFFT will use AVX if the CPU supports it. If not, it will check for SSE4.1.
+# If neither instruction set is available, it will fall back to the scalar code.  
+# On every other platform, these features do nothing, and RustFFT will behave like they are not set.
 avx = []
+sse = []
+
 
 [dependencies]
 num-complex = "0.3"
@@ -29,3 +35,4 @@ primal-check = "0.3.1"
 
 [dev-dependencies]
 rand = "0.6"
+paste = "1.0.4"
diff --git a/README.md b/README.md
@@ -10,6 +10,8 @@ RustFFT is a high-performance FFT library written in pure Rust. It can compute F
 
 RustFFT supports the AVX instruction set for increased performance. No special code is needed to activate AVX: Simply plan a FFT using the FftPlanner on a machine that supports the `avx` and `fma` CPU features, and RustFFT will automatically switch to faster AVX-accelerated algorithms.
 
+For machines that do not have AVX, it also supports the SSE4.1 instruction set. As for AVX, this is enabled automatically when using the FftPlanner.
+
 Unlike previous major versions, RustFFT 5.0 has several breaking changes compared to RustFFT 4.0. Check out the [Upgrade Guide](/UpgradeGuide4to5.md) for a walkthrough of the changes RustFFT 5.0 requires.
 
 ## Usage
@@ -31,6 +33,14 @@ fft.process(&mut buffer);
 RustFFT requires rustc 1.37 or newer. Minor releases of RustFFT may upgrade the MSRV(minimum supported Rust version) to a newer version of rustc.
 However, if we need to increase the MSRV, the new Rust version must have been released at least six months ago.
 
+## Features
+
+The features `avx` and `sse` are enabled by default. On x86_64, these features enable compilation of the AVX and SSE accelerated code. 
+
+Disabling them reduces compile time and binary size.
+
+On other platform than x86_64, these features do nothing and RustFFT will behave like they are not set.
+
 ## Stability/Future Breaking Changes
 
 Version 5.0 contains several breaking API changes. In the interest of stability, we're committing to making no more breaking changes for 3 years, aka until 2024.

diff --git a/benches/bench_check_scalar_2to1024.rs b/benches/bench_check_scalar_2to1024.rs
@@ -0,0 +1,168 @@
+#![feature(test)]
+extern crate rustfft;
+extern crate test;
+
+use paste::paste;
+use rustfft::num_complex::Complex;
+use rustfft::num_traits::Zero;
+use rustfft::Fft;
+use std::sync::Arc;
+use test::Bencher;
+
+// Make fft using planner
+fn bench_planned_32(b: &mut Bencher, len: usize) {
+    let mut planner = rustfft::FftPlannerScalar::new();
+    let fft: Arc<dyn Fft<f32>> = planner.plan_fft_forward(len);
+
+    let mut buffer: Vec<Complex<f32>> = vec![Complex::zero(); len];
+    let mut scratch: Vec<Complex<f32>> = vec![Complex::zero(); fft.get_inplace_scratch_len()];
+    b.iter(|| {
+        fft.process_with_scratch(&mut buffer, &mut scratch);
+    });
+}
+
+// Make fft using planner
+fn bench_planned_64(b: &mut Bencher, len: usize) {
+    let mut planner = rustfft::FftPlannerScalar::new();
+    let fft: Arc<dyn Fft<f64>> = planner.plan_fft_forward(len);
+
+    let mut buffer: Vec<Complex<f64>> = vec![Complex::zero(); len];
+    let mut scratch: Vec<Complex<f64>> = vec![Complex::zero(); fft.get_inplace_scratch_len()];
+    b.iter(|| {
+        fft.process_with_scratch(&mut buffer, &mut scratch);
+    });
+}
+
+// Create benches using functions taking one argument
+macro_rules! make_benches {
+    ($name:ident, $fname:ident, { $($len:literal),* }) => {
+        paste! {
+            $(
+                #[bench]
+                fn [<bench_ $name _f32_ $len>](b: &mut Bencher)  {
+                    [<bench_ $fname _32>](b, $len);
+                }
+
+                #[bench]
+                fn [<bench_ $name _f64_ $len>](b: &mut Bencher)  {
+                    [<bench_ $fname _64>](b, $len);
+                }
+            )*
+        }
+    }
+}
+
+make_benches!(from2to1024, planned, {2, 3, 4, 5, 6, 7, 8, 9 });
+make_benches!(from2to1024, planned, {10, 11, 12, 13, 14, 15, 16, 17, 18, 19 });
+make_benches!(from2to1024, planned, {20, 21, 22, 23, 24, 25, 26, 27, 28, 29 });
+make_benches!(from2to1024, planned, {30, 31, 32, 33, 34, 35, 36, 37, 38, 39 });
+make_benches!(from2to1024, planned, {40, 41, 42, 43, 44, 45, 46, 47, 48, 49 });
+make_benches!(from2to1024, planned, {50, 51, 52, 53, 54, 55, 56, 57, 58, 59 });
+make_benches!(from2to1024, planned, {60, 61, 62, 63, 64, 65, 66, 67, 68, 69 });
+make_benches!(from2to1024, planned, {70, 71, 72, 73, 74, 75, 76, 77, 78, 79 });
+make_benches!(from2to1024, planned, {80, 81, 82, 83, 84, 85, 86, 87, 88, 89 });
+make_benches!(from2to1024, planned, {90, 91, 92, 93, 94, 95, 96, 97, 98, 99 });
+
+make_benches!(from2to1024, planned, {100, 101, 102, 103, 104, 105, 106, 107, 108, 109 });
+make_benches!(from2to1024, planned, {110, 111, 112, 113, 114, 115, 116, 117, 118, 119 });
+make_benches!(from2to1024, planned, {120, 121, 122, 123, 124, 125, 126, 127, 128, 129 });
+make_benches!(from2to1024, planned, {130, 131, 132, 133, 134, 135, 136, 137, 138, 139 });
+make_benches!(from2to1024, planned, {140, 141, 142, 143, 144, 145, 146, 147, 148, 149 });
+make_benches!(from2to1024, planned, {150, 151, 152, 153, 154, 155, 156, 157, 158, 159 });
+make_benches!(from2to1024, planned, {160, 161, 162, 163, 164, 165, 166, 167, 168, 169 });
+make_benches!(from2to1024, planned, {170, 171, 172, 173, 174, 175, 176, 177, 178, 179 });
+make_benches!(from2to1024, planned, {180, 181, 182, 183, 184, 185, 186, 187, 188, 189 });
+make_benches!(from2to1024, planned, {190, 191, 192, 193, 194, 195, 196, 197, 198, 199 });
+/*
+make_benches!(from2to1024, planned, {200, 201, 202, 203, 204, 205, 206, 207, 208, 209 });
+make_benches!(from2to1024, planned, {210, 211, 212, 213, 214, 215, 216, 217, 218, 219 });
+make_benches!(from2to1024, planned, {220, 221, 222, 223, 224, 225, 226, 227, 228, 229 });
+make_benches!(from2to1024, planned, {230, 231, 232, 233, 234, 235, 236, 237, 238, 239 });
+make_benches!(from2to1024, planned, {240, 241, 242, 243, 244, 245, 246, 247, 248, 249 });
+make_benches!(from2to1024, planned, {250, 251, 252, 253, 254, 255, 256, 257, 258, 259 });
+make_benches!(from2to1024, planned, {260, 261, 262, 263, 264, 265, 266, 267, 268, 269 });
+make_benches!(from2to1024, planned, {270, 271, 272, 273, 274, 275, 276, 277, 278, 279 });
+make_benches!(from2to1024, planned, {280, 281, 282, 283, 284, 285, 286, 287, 288, 289 });
+make_benches!(from2to1024, planned, {290, 291, 292, 293, 294, 295, 296, 297, 298, 299 });
+
+make_benches!(from2to1024, planned, {300, 301, 302, 303, 304, 305, 306, 307, 308, 309 });
+make_benches!(from2to1024, planned, {310, 311, 312, 313, 314, 315, 316, 317, 318, 319 });
+make_benches!(from2to1024, planned, {320, 321, 322, 323, 324, 325, 326, 327, 328, 329 });
+make_benches!(from2to1024, planned, {330, 331, 332, 333, 334, 335, 336, 337, 338, 339 });
+make_benches!(from2to1024, planned, {340, 341, 342, 343, 344, 345, 346, 347, 348, 349 });
+make_benches!(from2to1024, planned, {350, 351, 352, 353, 354, 355, 356, 357, 358, 359 });
+make_benches!(from2to1024, planned, {360, 361, 362, 363, 364, 365, 366, 367, 368, 369 });
+make_benches!(from2to1024, planned, {370, 371, 372, 373, 374, 375, 376, 377, 378, 379 });
+make_benches!(from2to1024, planned, {380, 381, 382, 383, 384, 385, 386, 387, 388, 389 });
+make_benches!(from2to1024, planned, {390, 391, 392, 393, 394, 395, 396, 397, 398, 399 });
+
+make_benches!(from2to1024, planned, {400, 401, 402, 403, 404, 405, 406, 407, 408, 409 });
+make_benches!(from2to1024, planned, {410, 411, 412, 413, 414, 415, 416, 417, 418, 419 });
+make_benches!(from2to1024, planned, {420, 421, 422, 423, 424, 425, 426, 427, 428, 429 });
+make_benches!(from2to1024, planned, {430, 431, 432, 433, 434, 435, 436, 437, 438, 439 });
+make_benches!(from2to1024, planned, {440, 441, 442, 443, 444, 445, 446, 447, 448, 449 });
+make_benches!(from2to1024, planned, {450, 451, 452, 453, 454, 455, 456, 457, 458, 459 });
+make_benches!(from2to1024, planned, {460, 461, 462, 463, 464, 465, 466, 467, 468, 469 });
+make_benches!(from2to1024, planned, {470, 471, 472, 473, 474, 475, 476, 477, 478, 479 });
+make_benches!(from2to1024, planned, {480, 481, 482, 483, 484, 485, 486, 487, 488, 489 });
+make_benches!(from2to1024, planned, {490, 491, 492, 493, 494, 495, 496, 497, 498, 499 });
+
+make_benches!(from2to1024, planned, {500, 501, 502, 503, 504, 505, 506, 507, 508, 509 });
+make_benches!(from2to1024, planned, {510, 511, 512, 513, 514, 515, 516, 517, 518, 519 });
+make_benches!(from2to1024, planned, {520, 521, 522, 523, 524, 525, 526, 527, 528, 529 });
+make_benches!(from2to1024, planned, {530, 531, 532, 533, 534, 535, 536, 537, 538, 539 });
+make_benches!(from2to1024, planned, {540, 541, 542, 543, 544, 545, 546, 547, 548, 549 });
+make_benches!(from2to1024, planned, {550, 551, 552, 553, 554, 555, 556, 557, 558, 559 });
+make_benches!(from2to1024, planned, {560, 561, 562, 563, 564, 565, 566, 567, 568, 569 });
+make_benches!(from2to1024, planned, {570, 571, 572, 573, 574, 575, 576, 577, 578, 579 });
+make_benches!(from2to1024, planned, {580, 581, 582, 583, 584, 585, 586, 587, 588, 589 });
+make_benches!(from2to1024, planned, {590, 591, 592, 593, 594, 595, 596, 597, 598, 599 });
+
+make_benches!(from2to1024, planned, {600, 601, 602, 603, 604, 605, 606, 607, 608, 609 });
+make_benches!(from2to1024, planned, {610, 611, 612, 613, 614, 615, 616, 617, 618, 619 });
+make_benches!(from2to1024, planned, {620, 621, 622, 623, 624, 625, 626, 627, 628, 629 });
+make_benches!(from2to1024, planned, {630, 631, 632, 633, 634, 635, 636, 637, 638, 639 });
+make_benches!(from2to1024, planned, {640, 641, 642, 643, 644, 645, 646, 647, 648, 649 });
+make_benches!(from2to1024, planned, {650, 651, 652, 653, 654, 655, 656, 657, 658, 659 });
+make_benches!(from2to1024, planned, {660, 661, 662, 663, 664, 665, 666, 667, 668, 669 });
+make_benches!(from2to1024, planned, {670, 671, 672, 673, 674, 675, 676, 677, 678, 679 });
+make_benches!(from2to1024, planned, {680, 681, 682, 683, 684, 685, 686, 687, 688, 689 });
+make_benches!(from2to1024, planned, {690, 691, 692, 693, 694, 695, 696, 697, 698, 699 });
+
+make_benches!(from2to1024, planned, {700, 701, 702, 703, 704, 705, 706, 707, 708, 709 });
+make_benches!(from2to1024, planned, {710, 711, 712, 713, 714, 715, 716, 717, 718, 719 });
+make_benches!(from2to1024, planned, {720, 721, 722, 723, 724, 725, 726, 727, 728, 729 });
+make_benches!(from2to1024, planned, {730, 731, 732, 733, 734, 735, 736, 737, 738, 739 });
+make_benches!(from2to1024, planned, {740, 741, 742, 743, 744, 745, 746, 747, 748, 749 });
+make_benches!(from2to1024, planned, {750, 751, 752, 753, 754, 755, 756, 757, 758, 759 });
+make_benches!(from2to1024, planned, {760, 761, 762, 763, 764, 765, 766, 767, 768, 769 });
+make_benches!(from2to1024, planned, {770, 771, 772, 773, 774, 775, 776, 777, 778, 779 });
+make_benches!(from2to1024, planned, {780, 781, 782, 783, 784, 785, 786, 787, 788, 789 });
+make_benches!(from2to1024, planned, {790, 791, 792, 793, 794, 795, 796, 797, 798, 799 });
+
+make_benches!(from2to1024, planned, {800, 801, 802, 803, 804, 805, 806, 807, 808, 809 });
+make_benches!(from2to1024, planned, {810, 811, 812, 813, 814, 815, 816, 817, 818, 819 });
+make_benches!(from2to1024, planned, {820, 821, 822, 823, 824, 825, 826, 827, 828, 829 });
+make_benches!(from2to1024, planned, {830, 831, 832, 833, 834, 835, 836, 837, 838, 839 });
+make_benches!(from2to1024, planned, {840, 841, 842, 843, 844, 845, 846, 847, 848, 849 });
+make_benches!(from2to1024, planned, {850, 851, 852, 853, 854, 855, 856, 857, 858, 859 });
+make_benches!(from2to1024, planned, {860, 861, 862, 863, 864, 865, 866, 867, 868, 869 });
+make_benches!(from2to1024, planned, {870, 871, 872, 873, 874, 875, 876, 877, 878, 879 });
+make_benches!(from2to1024, planned, {880, 881, 882, 883, 884, 885, 886, 887, 888, 889 });
+make_benches!(from2to1024, planned, {890, 891, 892, 893, 894, 895, 896, 897, 898, 899 });
+
+make_benches!(from2to1024, planned, {900, 901, 902, 903, 904, 905, 906, 907, 908, 909 });
+make_benches!(from2to1024, planned, {910, 911, 912, 913, 914, 915, 916, 917, 918, 919 });
+make_benches!(from2to1024, planned, {920, 921, 922, 923, 924, 925, 926, 927, 928, 929 });
+make_benches!(from2to1024, planned, {930, 931, 932, 933, 934, 935, 936, 937, 938, 939 });
+make_benches!(from2to1024, planned, {940, 941, 942, 943, 944, 945, 946, 947, 948, 949 });
+make_benches!(from2to1024, planned, {950, 951, 952, 953, 954, 955, 956, 957, 958, 959 });
+make_benches!(from2to1024, planned, {960, 961, 962, 963, 964, 965, 966, 967, 968, 969 });
+make_benches!(from2to1024, planned, {970, 971, 972, 973, 974, 975, 976, 977, 978, 979 });
+make_benches!(from2to1024, planned, {980, 981, 982, 983, 984, 985, 986, 987, 988, 989 });
+make_benches!(from2to1024, planned, {990, 991, 992, 993, 994, 995, 996, 997, 998, 999 });
+
+make_benches!(from2to1024, planned, {1000, 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009 });
+make_benches!(from2to1024, planned, {1010, 1011, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019 });
+make_benches!(from2to1024, planned, {1020, 1021, 1022, 1023, 1024 });
+*/