A generic framework for on-demand, incrementalized computation. Inspired by adapton, glimmer, and rustc's query system.
Find a file
bors[bot] 20c7834ff3
Merge #428
428: salsa-2022: fix hanging cancellations due to cvar not being notified r=nikomatsakis a=manapointer

This PR fixes an issue with the `cvar` condvar field of `Shared<DB>` not being notified when `Arc<Shared<DB>>`s were getting dropped. 

Previously, the condvar was being notified here:

```rust
impl<DB> Drop for Shared<DB>
where
    DB: HasJars,
{
    fn drop(&mut self) {
        self.cvar.notify_all();
    }
}
```

However, because this is implemented on `Shared<DB>`, the `drop` code only ran after all `Arc<Shared<DB>>`s (including that of the actual database and not just its snapshots) had dropped first, even though the intention was for the `drop` code to run when each individual `Arc<Shared<DB>>` was dropped so that the condvar would be notified each time.

To fix this, I've modified the `Shared<DB>` struct to instead hold `Arc`s to both the jars and the condvar, and `Storage` now holds `Shared<DB>` directly rather than `Arc<Shared<DB>>`. When `Shared<DB>` is dropped, it first drops its `Arc` for the jars, and then notifies the condvar.

## Note 
On my local branch I have a test case for this functionality, although it relied on timing using `std:🧵:sleep`. I figured this was less than ideal, so I decided not to include it in this PR - I'd love to get feedback on a better way to test this!

Co-authored-by: manapointer <manapointer@gmail.com>
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
2022-12-29 16:37:53 +00:00
.github/workflows Update test.yml 2022-08-24 18:45:53 +02:00
book Correct docs to refer to #[salsa::cycle] 2022-09-16 11:10:06 +00:00
components Update components/salsa-2022/src/storage.rs 2022-12-29 11:37:06 -05:00
examples Remove ': salsa::Database' bound from two examples 2021-12-30 11:02:30 +00:00
examples-2022 Update on-demand input docs 2022-09-16 00:14:54 +01:00
salsa-2022-tests Merge #423 2022-11-29 04:54:45 +00:00
src Merge #381 2022-08-25 10:34:44 +00:00
tests Fix clippy issues 2022-08-24 18:45:53 +02:00
.dir-locals.el ask emacs to rustfmt on save 2018-09-28 11:26:57 -04:00
.gitignore Fix clippy issues 2022-08-24 18:45:53 +02:00
bors.toml Update book workflow 2021-09-28 22:03:05 +02:00
Cargo.toml Move calc and lazy-input examples to examples-2022 2022-09-16 00:14:44 +01:00
FAQ.md Update New Mexico state question 2020-06-26 15:48:29 +01:00
LICENSE-APACHE add readme, license, etc 2018-09-28 11:01:27 -04:00
LICENSE-MIT add readme, license, etc 2018-09-28 11:01:27 -04:00
README.md Fix Chinese book link 2022-09-24 01:00:36 +09:00
RELEASES.md highlight breaking changes 2019-08-15 08:08:00 -04:00
rustfmt.toml add empty/default rustfmt.toml 2022-08-22 19:19:22 +08:00

salsa

Test Book Released API docs Crates.io

A generic framework for on-demand, incrementalized computation.

Salsa Logo

Obligatory warning

Very much a WORK IN PROGRESS at this point. Ready for experimental use but expect frequent breaking changes.

Credits

This system is heavily inspired by adapton, glimmer, and rustc's query system. So credit goes to Eduard-Mihai Burtescu, Matthew Hammer, Yehuda Katz, and Michael Woerister.

Key idea

The key idea of salsa is that you define your program as a set of queries. Every query is used like function K -> V that maps from some key of type K to a value of type V. Queries come in two basic varieties:

  • Inputs: the base inputs to your system. You can change these whenever you like.
  • Functions: pure functions (no side effects) that transform your inputs into other values. The results of queries are memoized to avoid recomputing them a lot. When you make changes to the inputs, we'll figure out (fairly intelligently) when we can re-use these memoized values and when we have to recompute them.

Want to learn more?

To learn more about Salsa, try one of the following:

Getting in touch

The bulk of the discussion happens in the issues and pull requests, but we have a zulip chat as well.