A generic framework for on-demand, incrementalized computation. Inspired by adapton, glimmer, and rustc's query system.
Find a file
Niko Matsakis cd5622c6de make query method get by default
Use `Query.set(db, key, value)` to set. Not sure about this.
2018-10-05 05:28:51 -04:00
examples make query method get by default 2018-10-05 05:28:51 -04:00
src make query method get by default 2018-10-05 05:28:51 -04:00
tests make query method get by default 2018-10-05 05:28:51 -04:00
.dir-locals.el ask emacs to rustfmt on save 2018-09-28 11:26:57 -04:00
.gitignore warn people not to use this :) 2018-09-29 06:05:04 -04:00
.travis.yml add travis.yml support 2018-09-30 07:39:52 -04:00
Cargo.toml bump to v0.3.0 2018-10-02 20:12:52 -04:00
FAQ.md update FAQ with a link 2018-10-02 05:52:27 -04: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 rename query context to database 2018-10-05 04:54:51 -04:00

salsa

A generic framework for on-demand, incrementalized computation.

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. 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 is 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.

How to use Salsa in three easy steps

Using salsa is as easy as 1, 2, 3...

  1. Define one or more database traits that contain the inputs and queries you will need. We'll start with one such trait, but later on you can use more than one to break up your system into components (or spread your code across crates).
  2. Implement the queries using the query_definition! macro.
  3. Define the database struct, which contains the storage for all the inputs/queries you will be using. The query struct will contain the storage for all of the inputs/queries and may also contain anything else that your code needs (e.g., configuration data).

To see an example of this in action, check out the hello_world example, which has a number of comments explaining how things work. The hello_world README has a more detailed writeup.