diff --git a/Cargo.lock b/Cargo.lock index 6bd99ea..c47c9d4 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -20,6 +20,14 @@ version = "1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" +[[package]] +name = "chili" +version = "0.1.0" +dependencies = [ + "divan", + "rayon", +] + [[package]] name = "clap" version = "4.5.16" @@ -187,14 +195,6 @@ dependencies = [ "windows-sys 0.52.0", ] -[[package]] -name = "spice" -version = "0.1.0" -dependencies = [ - "divan", - "rayon", -] - [[package]] name = "syn" version = "2.0.75" diff --git a/Cargo.toml b/Cargo.toml index 75cdf28..700a9b0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,15 @@ [package] -name = "spice" +name = "chili" +description = "low-overhead parallelization library" version = "0.1.0" edition = "2021" +authors = ["Dragoș Tiselice "] +repository = "https://github.com/dragostis/chili" +documentation = "https://docs.rs/chili" +keywords = ["join", "concurrency", "parallel", "spice"] +categories = ["concurrency"] +license = "MIT OR Apache-2.0" +readme = "README.md" [features] bench = ["dep:divan", "dep:rayon"] diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..d9a10c0 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..9cf1062 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,19 @@ +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6941796 --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +# chili + +[![Crates.io](https://img.shields.io/crates/v/chili.svg)](https://crates.io/crates/chili) +[![Docs](https://docs.rs/chili/badge.svg)](https://docs.rs/chili) + +## Rust port of [Spice], a low-overhead parallelization library + +Very low-overhead parallelization primitive, almost identical to +[`rayon::join`]. At any fork point during computation, it *may* run the two +passed closures in parallel. + +It works best in cases where there are many small computations and where it is +expensive to estimate how many are left on the current branch in order to stop trying to share work across threads. + +## Example + +The following example sums up all nodes in a binary tree in parallel. + +```rust +fn sum(node: &Node, scope: &mut Scope<'_>) -> u64 { + let (left, right) = scope.join( + |s| node.left.as_deref().map(|n| sum(n, s)).unwrap_or_default(), + |s| node.right.as_deref().map(|n| sum(n, s)).unwrap_or_default(), + ); + + node.val + left + right +} +``` + +This is the ideal example since per-node computation is very cheap and the +nodes don't keep track of how many descendants are left. + +## Benchmarks + +The following benchmarks measure the time it takes to sum up all the values in +a balanced binary tree with varying number of nodes. + +### AMD Ryzen 7 4800HS (8 cores) + +While the improvement over the baseline in the 134M nodes case is close to the +theoretical maximum, it's worth noting that the actual time per node is 0.8ns +vs. a theoretical 1.8 / 8 = 0.2ns, if we're to compare against the 1K nodes +case. + +| Number of nodes | Baseline | Rayon | chili | Baseline / chili | +|----------------:|---------:|---------:|---------:|:----------------:| +| 1023 | 1.8 µs | 51.1 µs | 3.4 µs | **x0.53** | +| 16777215 | 94.4 ms | 58.1 ms | 13.6 ms | **x6.94** | +| 134217727 | 797.5 ms | 497.2 ms | 101.8 ms | **x7.83** | + +### Apple M1 (8 cores) + +| Number of nodes | Baseline | Rayon | chili | Baseline / chili | +|----------------:|---------:|---------:|---------:|:----------------:| +| 1023 | 1.6 µs | 29.2 µs | 3.5 µs | **x0.46** | +| 16777215 | 39.4 ms | 40.5 ms | 11.2 ms | **x3.51** | +| 67108863 | 156.5 ms | 167.1 ms | 44.3 ms | **x3.53** | + +### chili overhead on AMD Ryzen 7 4800HS (8 cores) + +The overhead in the 1K nodes case remains approximately constant with respect +to the number of threads. + +| Number of nodes | Baseline | 1 thread | 2 threads | 4 threads | 8 threads | +|----------------:|---------:|---------:|----------:|----------:|----------:| +| 1023 | 1.8 ns | 3.5 ns | 3.5 µs | 3.5 µs | 3.5 µs | + +[Spice]: https://github.com/judofyr/spice +[`rayon::join`]: https://docs.rs/rayon/latest/rayon/fn.join.html \ No newline at end of file diff --git a/benches/overhead.rs b/benches/overhead.rs index c0c5c06..c707e92 100644 --- a/benches/overhead.rs +++ b/benches/overhead.rs @@ -1,5 +1,5 @@ +use chili::{Scope, ThreadPool}; use divan::Bencher; -use spice::{Scope, ThreadPool}; struct Node { val: u64, @@ -55,7 +55,7 @@ fn no_overhead(bencher: Bencher, nodes: (usize, usize)) { } #[divan::bench(args = nodes())] -fn spice_overhead(bencher: Bencher, nodes: (usize, usize)) { +fn chili_overhead(bencher: Bencher, nodes: (usize, usize)) { fn sum(node: &Node, scope: &mut Scope<'_>) -> u64 { let (left, right) = scope.join( |s| node.left.as_deref().map(|n| sum(n, s)).unwrap_or_default(), diff --git a/src/lib.rs b/src/lib.rs index 83d6c0b..069efd0 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,13 +1,21 @@ #![deny(missing_docs)] #![deny(unsafe_op_in_unsafe_fn)] +//! # chili. Rust port of [Spice], a low-overhead parallelization library +//! //! A crate for very low-overhead fork-join workloads that can potentially be //! run in parallel. //! +//! It works best in cases where there are many small computations and where it +//! is expensive to estimate how many are left on the current branch in order +//! to stop trying to share work across threads. +//! +//! [Spice]: https://github.com/judofyr/spice +//! //! # Examples //! //! ``` -//! # use spice::{Scope, ThreadPool}; +//! # use chili::{Scope, ThreadPool}; //! struct Node { //! val: u64, //! left: Option>, @@ -166,7 +174,7 @@ impl DerefMut for ThreadJobQueue<'_> { /// # Examples /// /// ``` -/// # use spice::ThreadPool; +/// # use chili::ThreadPool; /// let mut tp = ThreadPool::new().unwrap(); /// let mut s = tp.scope(); /// @@ -349,7 +357,7 @@ impl<'s> Scope<'s> { /// # Examples /// /// ``` - /// # use spice::ThreadPool; + /// # use chili::ThreadPool; /// let mut tp = ThreadPool::new().unwrap(); /// let mut s = tp.scope(); /// @@ -379,7 +387,7 @@ impl<'s> Scope<'s> { /// # Examples /// /// ``` - /// # use spice::ThreadPool; + /// # use chili::ThreadPool; /// let mut tp = ThreadPool::new().unwrap(); /// let mut s = tp.scope(); /// @@ -445,7 +453,7 @@ impl ThreadPool { /// # Examples /// /// ``` - /// # use spice::ThreadPool; + /// # use chili::ThreadPool; /// let _tp = ThreadPool::new().unwrap(); /// ``` pub fn new() -> Option { @@ -458,7 +466,7 @@ impl ThreadPool { /// /// ``` /// # use std::time::Duration; - /// # use spice::{Config, ThreadPool}; + /// # use chili::{Config, ThreadPool}; /// let _tp = ThreadPool::with_config(Config { /// thread_count: Some(1), /// heartbeat_interval: Duration::from_micros(50), @@ -504,7 +512,7 @@ impl ThreadPool { /// # Examples /// /// ``` - /// # use spice::ThreadPool; + /// # use chili::ThreadPool; /// let mut tp = ThreadPool::new().unwrap(); /// let mut s = tp.scope(); ///