pax_global_header 0000666 0000000 0000000 00000000064 15077662435 0014531 g ustar 00root root 0000000 0000000 52 comment=cdd0b85516a52c18b8a6d17a2279a96ed6c3e198
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/ 0000775 0000000 0000000 00000000000 15077662435 0017645 5 ustar 00root root 0000000 0000000 salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/.devcontainer/ 0000775 0000000 0000000 00000000000 15077662435 0022404 5 ustar 00root root 0000000 0000000 salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/.devcontainer/devcontainer.json 0000664 0000000 0000000 00000002233 15077662435 0025760 0 ustar 00root root 0000000 0000000 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/rust
{
"name": "Rust",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/rust:1-1-bullseye",
"features": {
"ghcr.io/devcontainers-contrib/features/ripgrep:1": {}
}
// Use 'mounts' to make the cargo cache persistent in a Docker Volume.
// "mounts": [
// {
// "source": "devcontainer-cargo-cache-${devcontainerId}",
// "target": "/usr/local/cargo",
// "type": "volume"
// }
// ]
// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],
// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "rustc --version",
// Configure tool-specific properties.
// "customizations": {},
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/.dir-locals.el 0000664 0000000 0000000 00000000050 15077662435 0022271 0 ustar 00root root 0000000 0000000 ((rust-mode (rust-format-on-save . t)))
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/.github/ 0000775 0000000 0000000 00000000000 15077662435 0021205 5 ustar 00root root 0000000 0000000 salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/.github/dependabot.yml 0000664 0000000 0000000 00000000723 15077662435 0024037 0 ustar 00root root 0000000 0000000 # To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for more information:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
# https://containers.dev/guide/dependabot
version: 2
updates:
- package-ecosystem: "devcontainers"
directory: "/"
schedule:
interval: weekly
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/.github/workflows/ 0000775 0000000 0000000 00000000000 15077662435 0023242 5 ustar 00root root 0000000 0000000 salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/.github/workflows/book.yml 0000664 0000000 0000000 00000003535 15077662435 0024725 0 ustar 00root root 0000000 0000000 name: Book
on:
push:
branches:
- master
pull_request:
paths:
- "book/**"
- ".github/workflows/book.yml"
jobs:
book:
name: Book
runs-on: ubuntu-latest
env:
MDBOOK_VERSION: "0.4.40"
MDBOOK_LINKCHECK_VERSION: "0.7.7"
MDBOOK_MERMAID_VERSION: "0.13.0"
steps:
- uses: actions/checkout@v4
- name: Install mdbook
run: |
curl -L https://github.com/rust-lang/mdBook/releases/download/v$MDBOOK_VERSION/mdbook-v$MDBOOK_VERSION-x86_64-unknown-linux-gnu.tar.gz | tar xz -C ~/.cargo/bin
curl -L https://github.com/badboy/mdbook-mermaid/releases/download/v$MDBOOK_MERMAID_VERSION/mdbook-mermaid-v$MDBOOK_MERMAID_VERSION-x86_64-unknown-linux-gnu.tar.gz | tar xz -C ~/.cargo/bin
curl -L https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/download/v$MDBOOK_LINKCHECK_VERSION/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip -O
unzip mdbook-linkcheck.x86_64-unknown-linux-gnu.zip -d ~/.cargo/bin
chmod +x ~/.cargo/bin/mdbook-linkcheck
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Build
run: mdbook build
working-directory: book
- name: Upload static files as artifact
id: deployment
uses: actions/upload-pages-artifact@v3
with:
path: ./book/book/html
deploy:
name: Deploy
runs-on: ubuntu-latest
needs: book
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
concurrency:
group: github-pages
cancel-in-progress: true
permissions:
contents: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/.github/workflows/release.yml 0000664 0000000 0000000 00000003050 15077662435 0025403 0 ustar 00root root 0000000 0000000 name: Release-plz
permissions:
pull-requests: write
contents: write
on:
push:
branches:
- master
jobs:
# Release unpublished packages.
release-plz-release:
if: ${{ github.repository_owner == 'salsa-rs' }}
name: Release-plz release
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Run release-plz
uses: release-plz/action@v0.5
with:
command: release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
# Create a PR with the new versions and changelog, preparing the next release.
release-plz-pr:
if: ${{ github.repository_owner == 'salsa-rs' }}
name: Release-plz PR
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
concurrency:
group: release-plz-${{ github.ref }}
cancel-in-progress: false
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Run release-plz
uses: release-plz/action@v0.5
with:
command: release-pr
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/.github/workflows/test.yml 0000664 0000000 0000000 00000012346 15077662435 0024752 0 ustar 00root root 0000000 0000000 name: Test
on:
pull_request:
merge_group:
push:
branches:
- master
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
jobs:
test:
name: Test
strategy:
matrix:
rust:
- 1.85.0
- stable
- beta
experimental:
- false
include:
- rust: nightly
experimental: true
continue-on-error: ${{ matrix.experimental }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@master
id: rust-toolchain
with:
toolchain: ${{ matrix.rust }}
components: rustfmt, clippy
- uses: taiki-e/install-action@nextest
- uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-${{ hashFiles('**/Cargo.toml') }}
restore-keys: |
${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-
${{ runner.os }}-cargo-
- name: Format
run: cargo fmt -- --check
- name: Clippy
run: cargo clippy --workspace --all-targets -- -D warnings
# TODO: Use something like cargo-hack for more robust feature configuration testing.
- name: Clippy / all-features
run: cargo clippy --workspace --all-targets --features persistence -- -D warnings
- name: Test
run: cargo nextest run --workspace --all-targets --features persistence --no-fail-fast
- name: Test Manual Registration / no-default-features
run: cargo nextest run --workspace --tests --no-fail-fast --no-default-features --features macros
- name: Test docs
run: cargo test --workspace --doc
miri:
name: Miri
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Miri
uses: dtolnay/rust-toolchain@miri
id: rust-toolchain
- uses: taiki-e/install-action@nextest
- uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-miri-${{ hashFiles('**/Cargo.toml') }}
restore-keys: |
${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-miri-
${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-
${{ runner.os }}-cargo-
- name: Setup Miri
run: cargo miri setup
- name: Test with Miri
run: cargo miri nextest run --no-fail-fast --tests
env:
MIRIFLAGS: -Zmiri-disable-isolation -Zmiri-retag-fields
- name: Run examples with Miri
run: cargo miri run --example calc
shuttle:
name: Shuttle
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@master
id: rust-toolchain
with:
toolchain: stable
- uses: taiki-e/install-action@nextest
- uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-${{ hashFiles('**/Cargo.toml') }}
restore-keys: |
${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-
${{ runner.os }}-cargo-
- name: Test with Shuttle
run: cargo nextest run --features shuttle --test parallel
benchmarks:
# https://github.com/CodSpeedHQ/action/issues/126
if: github.event_name != 'merge_group'
name: Benchmarks
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@master
id: rust-toolchain
with:
toolchain: stable
- name: "Setup codspeed"
uses: taiki-e/install-action@v2
with:
tool: cargo-codspeed
- uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-${{ hashFiles('**/Cargo.toml') }}
restore-keys: |
${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-benchmark
${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}
${{ runner.os }}-cargo-
- name: "Build benchmarks"
run: cargo codspeed build
- name: "Run benchmarks"
uses: CodSpeedHQ/action@v4
with:
mode: instrumentation
run: cargo codspeed run
token: ${{ secrets.CODSPEED_TOKEN }}
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/.gitignore 0000664 0000000 0000000 00000000057 15077662435 0021637 0 ustar 00root root 0000000 0000000 /target
**/*.rs.bk
Cargo.lock
TAGS
nikom
.idea
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/CHANGELOG.md 0000664 0000000 0000000 00000051232 15077662435 0021461 0 ustar 00root root 0000000 0000000 # Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [0.24.0](https://github.com/salsa-rs/salsa/compare/salsa-v0.23.0...salsa-v0.24.0) - 2025-09-30
### Fixed
- Cleanup provisional cycle head memos when query panics ([#993](https://github.com/salsa-rs/salsa/pull/993))
- Runaway for unchanged queries participating in cycle ([#981](https://github.com/salsa-rs/salsa/pull/981))
- Delete not re-created tracked structs after fixpoint iteration ([#979](https://github.com/salsa-rs/salsa/pull/979))
- fix assertion during interned deserialization ([#978](https://github.com/salsa-rs/salsa/pull/978))
- Do not unnecessarily require `Debug` on fields for interned structs ([#951](https://github.com/salsa-rs/salsa/pull/951))
- Fix phantom data usage in salsa structs affecting auto traits ([#932](https://github.com/salsa-rs/salsa/pull/932))
### Other
- Replace unsafe unwrap with `expect` call ([#998](https://github.com/salsa-rs/salsa/pull/998))
- Push active query in execute ([#996](https://github.com/salsa-rs/salsa/pull/996))
- Update codspeed action ([#997](https://github.com/salsa-rs/salsa/pull/997))
- Add implementations for Lookup and HashEqLike for CompactString ([#988](https://github.com/salsa-rs/salsa/pull/988))
- Provide a method to attach a database even if it's different from the current attached one ([#992](https://github.com/salsa-rs/salsa/pull/992))
- Allow fallback to take longer than one iteration to converge ([#991](https://github.com/salsa-rs/salsa/pull/991))
- refactor `entries` API ([#987](https://github.com/salsa-rs/salsa/pull/987))
- Persistent caching fixes ([#982](https://github.com/salsa-rs/salsa/pull/982))
- outline cold path of `lookup_ingredient` ([#984](https://github.com/salsa-rs/salsa/pull/984))
- Update snapshot to fix nightly type rendering ([#983](https://github.com/salsa-rs/salsa/pull/983))
- avoid cycles during serialization ([#977](https://github.com/salsa-rs/salsa/pull/977))
- Flatten unserializable query dependencies ([#975](https://github.com/salsa-rs/salsa/pull/975))
- optimize `Id::hash` ([#974](https://github.com/salsa-rs/salsa/pull/974))
- Make `thin-vec/serde` dependency dependent on `persistence` feature ([#973](https://github.com/salsa-rs/salsa/pull/973))
- Remove tracked structs from query outputs ([#969](https://github.com/salsa-rs/salsa/pull/969))
- Remove jemalloc ([#972](https://github.com/salsa-rs/salsa/pull/972))
- Initial persistent caching prototype ([#967](https://github.com/salsa-rs/salsa/pull/967))
- Fix `maybe_changed_after` runnaway for fixpoint queries ([#961](https://github.com/salsa-rs/salsa/pull/961))
- add parallel maybe changed after test ([#963](https://github.com/salsa-rs/salsa/pull/963))
- Update tests for Rust 1.89 ([#966](https://github.com/salsa-rs/salsa/pull/966))
- remove allocation lock ([#962](https://github.com/salsa-rs/salsa/pull/962))
- consolidate memory usage information API ([#964](https://github.com/salsa-rs/salsa/pull/964))
- Add heap size support for salsa structs ([#943](https://github.com/salsa-rs/salsa/pull/943))
- Extract the cycle branches from `fetch` and `maybe_changed_after` ([#955](https://github.com/salsa-rs/salsa/pull/955))
- allow reuse of cached provisional memos within the same cycle iteration during `maybe_changed_after` ([#954](https://github.com/salsa-rs/salsa/pull/954))
- Expose API to manually trigger cancellation ([#959](https://github.com/salsa-rs/salsa/pull/959))
- Upgrade dependencies ([#956](https://github.com/salsa-rs/salsa/pull/956))
- Use `CycleHeadSet` in `maybe_update_after` ([#953](https://github.com/salsa-rs/salsa/pull/953))
- Gate accumulator feature behind a feature flag ([#946](https://github.com/salsa-rs/salsa/pull/946))
- optimize allocation fast-path ([#949](https://github.com/salsa-rs/salsa/pull/949))
- remove borrow checks from `ZalsaLocal` ([#939](https://github.com/salsa-rs/salsa/pull/939))
- Do manual trait casting ([#922](https://github.com/salsa-rs/salsa/pull/922))
- Retain backing allocation of `ActiveQuery::input_outputs` in `ActiveQuery::seed_iteration` ([#948](https://github.com/salsa-rs/salsa/pull/948))
- remove extra bounds checks from memo table hot-paths ([#938](https://github.com/salsa-rs/salsa/pull/938))
- Outline all tracing events ([#942](https://github.com/salsa-rs/salsa/pull/942))
- remove bounds and type checks from `IngredientCache` ([#937](https://github.com/salsa-rs/salsa/pull/937))
- Avoid dynamic dispatch to access memo tables ([#941](https://github.com/salsa-rs/salsa/pull/941))
- optimize page access ([#940](https://github.com/salsa-rs/salsa/pull/940))
- Use `inventory` for static ingredient registration ([#934](https://github.com/salsa-rs/salsa/pull/934))
- Fix `heap_size` option not being preserved in tracked impls ([#930](https://github.com/salsa-rs/salsa/pull/930))
- update papaya ([#928](https://github.com/salsa-rs/salsa/pull/928))
## [0.23.0](https://github.com/salsa-rs/salsa/compare/salsa-v0.22.0...salsa-v0.23.0) - 2025-06-27
### Added
- `Update` derive field overwrite support ([#747](https://github.com/salsa-rs/salsa/pull/747))
### Fixed
- fix race in `MemoTableTypes` ([#912](https://github.com/salsa-rs/salsa/pull/912))
- multithreaded nested fixpoint iteration ([#882](https://github.com/salsa-rs/salsa/pull/882))
### Other
- Emit self ty for query debug name of assoc function queries ([#927](https://github.com/salsa-rs/salsa/pull/927))
- Replace ingredient cache with faster ingredient map ([#921](https://github.com/salsa-rs/salsa/pull/921))
- add option to track heap memory usage of memos ([#925](https://github.com/salsa-rs/salsa/pull/925))
- Hide generated structs of tracked functions from docs via `#[doc(hidden)]` ([#917](https://github.com/salsa-rs/salsa/pull/917))
- Add API to dump memory usage ([#916](https://github.com/salsa-rs/salsa/pull/916))
- Revert "Assert size for interned Value" & Mark `Slot` trait as unsafe ([#915](https://github.com/salsa-rs/salsa/pull/915))
- add an option to tune interned garbage collection ([#911](https://github.com/salsa-rs/salsa/pull/911))
- Use explicit discriminants for `QueryOriginKind` for better comparisons ([#913](https://github.com/salsa-rs/salsa/pull/913))
- update boxcar ([#910](https://github.com/salsa-rs/salsa/pull/910))
- use latest revision for dependencies on interned values ([#908](https://github.com/salsa-rs/salsa/pull/908))
- remove high-durability values from interned LRU ([#907](https://github.com/salsa-rs/salsa/pull/907))
- Preserve attributes on interned/tracked struct fields ([#905](https://github.com/salsa-rs/salsa/pull/905))
- Assert size for interned `Value` ([#901](https://github.com/salsa-rs/salsa/pull/901))
- reduce size of interned value metadata ([#903](https://github.com/salsa-rs/salsa/pull/903))
- panic with string message again for cycle panics ([#898](https://github.com/salsa-rs/salsa/pull/898))
- Use `Revision` and `Durability` directly in input `Value` ([#902](https://github.com/salsa-rs/salsa/pull/902))
- Fix flaky parallel_join test ([#900](https://github.com/salsa-rs/salsa/pull/900))
- Bump MSRV to 1.85 ([#899](https://github.com/salsa-rs/salsa/pull/899))
- Simple LRU garbage collection for interned values ([#839](https://github.com/salsa-rs/salsa/pull/839))
- Capture execution backtrace when throwing `UnexpectedCycle` ([#883](https://github.com/salsa-rs/salsa/pull/883))
- Store tracked struct ids as ThinVec on Revisions ([#892](https://github.com/salsa-rs/salsa/pull/892))
- Update dependencies, remove unused `heck` dependency ([#894](https://github.com/salsa-rs/salsa/pull/894))
- Set `validate_final` in `execute` after removing the last cycle head ([#890](https://github.com/salsa-rs/salsa/pull/890))
- Pack `QueryEdge` memory layout ([#886](https://github.com/salsa-rs/salsa/pull/886))
- Lazily allocate extra memo state ([#888](https://github.com/salsa-rs/salsa/pull/888))
- Pack `QueryOrigin` memory layout ([#885](https://github.com/salsa-rs/salsa/pull/885))
- Restrict memo size assertion to 64bit platforms ([#884](https://github.com/salsa-rs/salsa/pull/884))
- Don't report stale outputs if there is newer generation in new_outputs ([#879](https://github.com/salsa-rs/salsa/pull/879))
- Fix hang in nested fixpoint iteration ([#871](https://github.com/salsa-rs/salsa/pull/871))
- Add debug spans for `new_revision` and `evict_lru` ([#881](https://github.com/salsa-rs/salsa/pull/881))
- Add fetch span ([#875](https://github.com/salsa-rs/salsa/pull/875))
- shrink_to_fit `IdentityMap` before storing it ([#816](https://github.com/salsa-rs/salsa/pull/816))
- Allow lifetimes in arguments in tracked fns with >1 parameters ([#880](https://github.com/salsa-rs/salsa/pull/880))
- Replace loom with shuttle ([#876](https://github.com/salsa-rs/salsa/pull/876))
- Use generational identifiers for tracked structs ([#864](https://github.com/salsa-rs/salsa/pull/864))
### Fixed
- `#[doc(hidden)]` auto-generated tracked-fn structs ([#917](https://github.com/salsa-rs/salsa/pull/917))
## [0.22.0](https://github.com/salsa-rs/salsa/compare/salsa-v0.21.1...salsa-v0.22.0) - 2025-05-23
### Fixed
- fix memo table growth condition ([#850](https://github.com/salsa-rs/salsa/pull/850))
- incorrect caching for queries participating in fixpoint ([#843](https://github.com/salsa-rs/salsa/pull/843))
- change detection for fixpoint queries ([#836](https://github.com/salsa-rs/salsa/pull/836))
### Other
- Allow creation of tracked associated functions (without `self`) ([#859](https://github.com/salsa-rs/salsa/pull/859))
- Short-circuit `block-on` if same thread ([#862](https://github.com/salsa-rs/salsa/pull/862))
- Skip release-plz jobs on forks ([#873](https://github.com/salsa-rs/salsa/pull/873))
- Unwind with specific type when encountering an unexpected cycle ([#856](https://github.com/salsa-rs/salsa/pull/856))
- Remove jar mentions from book ([#775](https://github.com/salsa-rs/salsa/pull/775))
- Implement an `!Update` bound escape hatch for tracked fn ([#867](https://github.com/salsa-rs/salsa/pull/867))
- Only enable `boxcar/loom` when `loom` feature is enabled ([#869](https://github.com/salsa-rs/salsa/pull/869))
- Remove default `PartialOrd` and `Ord` derives for salsa-structs ([#868](https://github.com/salsa-rs/salsa/pull/868))
- update boxcar ([#865](https://github.com/salsa-rs/salsa/pull/865))
- speed-up cycle-retry logic ([#861](https://github.com/salsa-rs/salsa/pull/861))
- Fix returns(deref | as_ref | as_deref) in tracked methods ([#857](https://github.com/salsa-rs/salsa/pull/857))
- Changed `return_ref` syntax to `returns(as_ref)` and `returns(cloned)` ([#772](https://github.com/salsa-rs/salsa/pull/772))
- Work around a rust-analyzer bug ([#855](https://github.com/salsa-rs/salsa/pull/855))
- Lazy finalization of cycle participants in `maybe_changed_after` ([#854](https://github.com/salsa-rs/salsa/pull/854))
- Do not re-verify already verified memoized value in cycle verification ([#851](https://github.com/salsa-rs/salsa/pull/851))
- Pass cycle heads as out parameter for `maybe_changed_after` ([#852](https://github.com/salsa-rs/salsa/pull/852))
- Move salsa event system into `Zalsa` ([#849](https://github.com/salsa-rs/salsa/pull/849))
- gate loom dependency under feature flag ([#844](https://github.com/salsa-rs/salsa/pull/844))
- Add loom support ([#842](https://github.com/salsa-rs/salsa/pull/842))
- Clean up some unsafety ([#830](https://github.com/salsa-rs/salsa/pull/830))
## [0.21.1](https://github.com/salsa-rs/salsa/compare/salsa-v0.21.0...salsa-v0.21.1) - 2025-04-30
### Added
- Make `attach` pub ([#832](https://github.com/salsa-rs/salsa/pull/832))
### Other
- better debug name for interned query arguments ([#837](https://github.com/salsa-rs/salsa/pull/837))
- Avoid panic in `Backtrace::capture` if `query_stack` is already borrowed ([#835](https://github.com/salsa-rs/salsa/pull/835))
- Clean up `function::execute` ([#833](https://github.com/salsa-rs/salsa/pull/833))
- Change an `assert!` to `assert_eq!` ([#828](https://github.com/salsa-rs/salsa/pull/828))
## [0.21.0](https://github.com/salsa-rs/salsa/compare/salsa-v0.20.0...salsa-v0.21.0) - 2025-04-29
### Fixed
- Access to tracked-struct that was freed during fixpoint ([#817](https://github.com/salsa-rs/salsa/pull/817))
- correct debug output for tracked fields ([#826](https://github.com/salsa-rs/salsa/pull/826))
- Fix incorrect `values_equal` signature ([#825](https://github.com/salsa-rs/salsa/pull/825))
- allow unused lifetimes in tracked_struct expansion ([#824](https://github.com/salsa-rs/salsa/pull/824))
### Other
- Implement a query stack `Backtrace` analog ([#827](https://github.com/salsa-rs/salsa/pull/827))
- Simplify ID conversions ([#822](https://github.com/salsa-rs/salsa/pull/822))
- Attempt to fix codspeed ([#823](https://github.com/salsa-rs/salsa/pull/823))
- Remove unnecessary `Array` abstraction ([#821](https://github.com/salsa-rs/salsa/pull/821))
- Add a compile-fail test for a `'static` `!Update` struct ([#820](https://github.com/salsa-rs/salsa/pull/820))
- squelch most clippy warnings in generated code ([#809](https://github.com/salsa-rs/salsa/pull/809))
- Include struct name in formatted input-field index ([#819](https://github.com/salsa-rs/salsa/pull/819))
- Force inline `fetch_hot` ([#818](https://github.com/salsa-rs/salsa/pull/818))
- Per ingredient sync table ([#650](https://github.com/salsa-rs/salsa/pull/650))
- Use `DatabaseKey` for interned events ([#813](https://github.com/salsa-rs/salsa/pull/813))
- [refactor] More `fetch_hot` simplification ([#793](https://github.com/salsa-rs/salsa/pull/793))
- Don't store the fields in the interned map ([#812](https://github.com/salsa-rs/salsa/pull/812))
- Fix ci not always running ([#810](https://github.com/salsa-rs/salsa/pull/810))
## [0.20.0](https://github.com/salsa-rs/salsa/compare/salsa-v0.19.0...salsa-v0.20.0) - 2025-04-22
### Added
- Drop `Debug` requirements and flip implementation defaults ([#756](https://github.com/salsa-rs/salsa/pull/756))
### Fixed
- Dereferencing freed memos when verifying provisional memos ([#788](https://github.com/salsa-rs/salsa/pull/788))
- `#[doc(hidden)]` `plumbing` module ([#781](https://github.com/salsa-rs/salsa/pull/781))
- Use `changed_at` revision when updating fields ([#778](https://github.com/salsa-rs/salsa/pull/778))
### Other
- Reduce memory usage by deduplicating type information ([#803](https://github.com/salsa-rs/salsa/pull/803))
- Make interned's `last_interned_at` equal `Revision::MAX` if they are interned outside a query ([#804](https://github.com/salsa-rs/salsa/pull/804))
- Add a third cycle mode, equivalent to old Salsa cycle behavior ([#801](https://github.com/salsa-rs/salsa/pull/801))
- Update compact_str from 0.8 to 0.9 ([#794](https://github.com/salsa-rs/salsa/pull/794))
- Implement `Update` for `ThinVec` ([#807](https://github.com/salsa-rs/salsa/pull/807))
- Don't push an unnecessary active query for `deep_verify_memo` ([#806](https://github.com/salsa-rs/salsa/pull/806))
- Inline/Outline more cold and slow paths ([#805](https://github.com/salsa-rs/salsa/pull/805))
- `#[inline]` some things ([#799](https://github.com/salsa-rs/salsa/pull/799))
- Discard unnecessary atomic load ([#780](https://github.com/salsa-rs/salsa/pull/780))
- Print query stack when encountering unexpected cycle ([#796](https://github.com/salsa-rs/salsa/pull/796))
- Remove incorrect `parallel_scope` API ([#797](https://github.com/salsa-rs/salsa/pull/797))
- [refactor] Simplify `fetch_hot` ([#792](https://github.com/salsa-rs/salsa/pull/792))
- [refactor] Reuse the same stack for all cycles heads in `validate_same_iteration` ([#791](https://github.com/salsa-rs/salsa/pull/791))
- add WillIterateCycle event ([#790](https://github.com/salsa-rs/salsa/pull/790))
- [fix] Use `validate_maybe_provisional` instead of `validate_provisional` ([#789](https://github.com/salsa-rs/salsa/pull/789))
- Use `ThinVec` for `CycleHeads` ([#787](https://github.com/salsa-rs/salsa/pull/787))
- Keep edge condvar on stack instead of allocating it in an `Arc` ([#773](https://github.com/salsa-rs/salsa/pull/773))
- allow reuse of cached provisional memos within the same cycle iteration ([#786](https://github.com/salsa-rs/salsa/pull/786))
- Implement `Lookup`/`HashEqLike` for `Arc` ([#784](https://github.com/salsa-rs/salsa/pull/784))
- Normalize imports style ([#779](https://github.com/salsa-rs/salsa/pull/779))
- Clean up `par_map` a bit ([#742](https://github.com/salsa-rs/salsa/pull/742))
- Fix typo in comment ([#777](https://github.com/salsa-rs/salsa/pull/777))
- Document most safety blocks ([#776](https://github.com/salsa-rs/salsa/pull/776))
- Use html directory for mdbook artifact ([#774](https://github.com/salsa-rs/salsa/pull/774))
- Move `verified_final` from `Memo` into `QueryRevisions` ([#769](https://github.com/salsa-rs/salsa/pull/769))
- Use `ThinVec` for `MemoTable`, halving its size ([#770](https://github.com/salsa-rs/salsa/pull/770))
- Remove unnecessary query stack acess in `block_on` ([#771](https://github.com/salsa-rs/salsa/pull/771))
- Replace memo queue with append-only vector ([#767](https://github.com/salsa-rs/salsa/pull/767))
- update boxcar ([#696](https://github.com/salsa-rs/salsa/pull/696))
- Remove extra page indirection in `Table` ([#710](https://github.com/salsa-rs/salsa/pull/710))
- update release steps ([#705](https://github.com/salsa-rs/salsa/pull/705))
- Remove some unnecessary panicking paths in cycle execution ([#765](https://github.com/salsa-rs/salsa/pull/765))
- *(perf)* Pool `ActiveQuerys` in the query stack ([#629](https://github.com/salsa-rs/salsa/pull/629))
- Resolve unwind safety fixme ([#761](https://github.com/salsa-rs/salsa/pull/761))
- Enable Garbage Collection for Interned Values ([#602](https://github.com/salsa-rs/salsa/pull/602))
- bug [salsa-macros]: Improve debug name of tracked methods ([#755](https://github.com/salsa-rs/salsa/pull/755))
- Remove dead code ([#764](https://github.com/salsa-rs/salsa/pull/764))
- Reduce unnecessary conditional work in `deep_verify_memo` ([#759](https://github.com/salsa-rs/salsa/pull/759))
- Use a `Vec` for `CycleHeads` ([#760](https://github.com/salsa-rs/salsa/pull/760))
- Use nextest for miri test runs ([#758](https://github.com/salsa-rs/salsa/pull/758))
- Pin `half` version to prevent CI failure ([#757](https://github.com/salsa-rs/salsa/pull/757))
- rewrite cycle handling to support fixed-point iteration ([#603](https://github.com/salsa-rs/salsa/pull/603))
## [0.19.0](https://github.com/salsa-rs/salsa/compare/salsa-v0.18.0...salsa-v0.19.0) - 2025-03-10
### Fixed
- fix typo
- fix enums bug
### Other
- Have salsa not depend on salsa-macros ([#750](https://github.com/salsa-rs/salsa/pull/750))
- Group versions of packages together for releases ([#751](https://github.com/salsa-rs/salsa/pull/751))
- use `portable-atomic` in `IngredientCache` to compile on `powerpc-unknown-linux-gnu` ([#749](https://github.com/salsa-rs/salsa/pull/749))
- Store view downcaster in function ingredients directly ([#720](https://github.com/salsa-rs/salsa/pull/720))
- Some small perf things ([#744](https://github.com/salsa-rs/salsa/pull/744))
- :replace instead of std::mem::replace ([#746](https://github.com/salsa-rs/salsa/pull/746))
- Cleanup `Cargo.toml`s ([#745](https://github.com/salsa-rs/salsa/pull/745))
- Drop clone requirement for accumulated values
- implement `Update` trait for `IndexMap`, and `IndexSet`
- more correct bounds on `Send` and `Sync` implementation `DeletedEntries`
- replace `arc-swap` with manual `AtomicPtr`
- Remove unnecessary `current_revision` call from `setup_interned_struct`
- Merge pull request #731 from Veykril/veykril/push-nzkwqzxxkxou
- Remove some dynamically dispatched `Database::event` calls
- Lazy fetching
- Add small supertype input benchmark
- Replace a `DashMap` with `RwLock` as writing is rare for it
- address review comments
- Skip memo ingredient index mapping for non enum tracked functions
- Trade off a bit of memory for more speed in `MemoIngredientIndices`
- Introduce Salsa enums
- Cancel duplicate test workflow runs
- implement `Update` trait for `hashbrown::HashMap`
- Move `unwind_if_revision_cancelled` from `ZalsaLocal` to `Zalsa`
- Don't clone strings in benchmarks
- Merge pull request #714 from Veykril/veykril/push-synxntlkqqsq
- Merge pull request #711 from Veykril/veykril/push-stmmwmtprovt
- Merge pull request #715 from Veykril/veykril/push-plwpsqknwulq
- Enforce `unsafe_op_in_unsafe_fn`
- Remove some `ZalsaDatabase::zalsa` calls
- Remove outdated FIXME
- Replace `IngredientCache` lock with atomic primitive
- Reduce method delegation duplication
- Automatically clear the cancellation flag when cancellation completes
- Allow trigger LRU eviction without increasing the current revision
- Simplify `Ingredient::reset_for_new_revision` setup
- Require mut Zalsa access for setting the lru limit
- Split off revision bumping from `zalsa_mut` access
- Update `hashbrown` (0.15) and `hashlink` (0.10)
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/Cargo.toml 0000664 0000000 0000000 00000006037 15077662435 0021603 0 ustar 00root root 0000000 0000000 [package]
name = "salsa"
version = "0.24.0"
authors.workspace = true
edition.workspace = true
license.workspace = true
repository.workspace = true
rust-version.workspace = true
description = "A generic framework for on-demand, incrementalized computation (experimental)"
[dependencies]
salsa-macro-rules = { version = "0.24.0", path = "components/salsa-macro-rules" }
salsa-macros = { version = "0.24.0", path = "components/salsa-macros", optional = true }
boxcar = "0.2.13"
crossbeam-queue = "0.3.12"
crossbeam-utils = "0.8.21"
hashbrown = "0.15"
hashlink = "0.10"
indexmap = "2"
intrusive-collections = "0.9.7"
parking_lot = "0.12"
portable-atomic = "1"
rustc-hash = "2"
smallvec = { version = "1", features = ["const_new"] }
thin-vec = { version = "0.2.14" }
tracing = { version = "0.1", default-features = false, features = ["std"] }
# Automatic ingredient registration.
inventory = { version = "0.3.20", optional = true }
# parallel map
rayon = { version = "1.10.0", optional = true }
# Stuff we want Update impls for by default
compact_str = { version = "0.9", optional = true }
shuttle = { version = "0.8.1", optional = true }
# Persistent caching
erased-serde = { version = "0.4.6", optional = true }
serde = { version = "1.0.219", features = ["derive"], optional = true }
[features]
default = ["salsa_unstable", "rayon", "macros", "inventory", "accumulator"]
inventory = ["dep:inventory"]
persistence = [
"dep:serde",
"dep:erased-serde",
"salsa-macros/persistence",
"thin-vec/serde",
]
shuttle = ["dep:shuttle"]
accumulator = ["salsa-macro-rules/accumulator"]
macros = ["dep:salsa-macros"]
# FIXME: remove `salsa_unstable` before 1.0.
salsa_unstable = []
# This interlocks the `salsa-macros` and `salsa` versions together
# preventing scenarios where they could diverge in a given project
# which may ultimately result in odd issues due to the proc-macro
# output mismatching with the declarative macro inputs
[target.'cfg(any())'.dependencies]
salsa-macros = { version = "=0.24.0", path = "components/salsa-macros" }
[dev-dependencies]
# examples
crossbeam-channel = "0.5.15"
dashmap = { version = "6", features = ["raw-api"] }
eyre = "0.6.12"
notify-debouncer-mini = "0.4.1"
ordered-float = "5.0.0"
# tests/benches
annotate-snippets = "0.11.5"
codspeed-criterion-compat = { version = "3.0.5", default-features = false }
expect-test = "1.5.1"
rustversion = "1.0"
test-log = { version = "0.2.18", features = ["trace"] }
trybuild = "1.0"
serde_json = "1.0.140"
[[bench]]
name = "compare"
harness = false
[[bench]]
name = "incremental"
harness = false
[[bench]]
name = "accumulator"
harness = false
required-features = ["accumulator"]
[[bench]]
name = "dataflow"
harness = false
[[example]]
name = "lazy-input"
required-features = ["accumulator"]
[[example]]
name = "calc"
required-features = ["accumulator"]
[workspace]
members = ["components/salsa-macro-rules", "components/salsa-macros"]
[workspace.package]
authors = ["Salsa developers"]
edition = "2021"
license = "Apache-2.0 OR MIT"
repository = "https://github.com/salsa-rs/salsa"
rust-version = "1.85"
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/FAQ.md 0000664 0000000 0000000 00000003062 15077662435 0020577 0 ustar 00root root 0000000 0000000 # Frequently asked questions
## Why is it called salsa?
I like salsa! Don't you?! Well, ok, there's a bit more to it. The
underlying algorithm for figuring out which bits of code need to be
re-executed after any given change is based on the algorithm used in
rustc. Michael Woerister and I first described the rustc algorithm in
terms of two colors, red and green, and hence we called it the
"red-green algorithm". This made me think of the New Mexico State
Question --- ["Red or green?"][nm] --- which refers to chile
(salsa). Although this version no longer uses colors (we borrowed
revision counters from Glimmer, instead), I still like the name.
[nm]: https://www.sos.state.nm.us/about-new-mexico/state-question/
## What is the relationship between salsa and an Entity-Component System (ECS)?
You may have noticed that Salsa "feels" a lot like an ECS in some
ways. That's true -- Salsa's queries are a bit like *components* (and
the keys to the queries are a bit like *entities*). But there is one
big difference: **ECS is -- at its heart -- a mutable system**. You
can get or set a component of some entity whenever you like. In
contrast, salsa's queries **define "derived values" via pure
computations**.
Partly as a consequence, ECS doesn't handle incremental updates for
you. When you update some component of some entity, you have to ensure
that other entities' components are updated appropriately.
Finally, ECS offers interesting metadata and "aspect-like" facilities,
such as iterating over all entities that share certain components.
Salsa has no analogue to that.
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/LICENSE-APACHE 0000664 0000000 0000000 00000025137 15077662435 0021601 0 ustar 00root root 0000000 0000000 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
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/LICENSE-MIT 0000664 0000000 0000000 00000001777 15077662435 0021315 0 ustar 00root root 0000000 0000000 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.
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/README.md 0000664 0000000 0000000 00000004564 15077662435 0021135 0 ustar 00root root 0000000 0000000 # salsa
[](https://github.com/salsa-rs/salsa/actions?query=workflow%3ATest)
[](https://github.com/salsa-rs/salsa/actions?query=workflow%3ABook)
[](https://docs.rs/salsa)
[](https://crates.io/crates/salsa)
*A generic framework for on-demand, incrementalized computation.*
## Obligatory warning
Very much a WORK IN PROGRESS at this point.
## Credits
This system is heavily inspired by [adapton](http://adapton.org/), [glimmer](https://github.com/glimmerjs/glimmer-vm), 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:
- read the [heavily commented examples](https://github.com/salsa-rs/salsa/tree/master/examples);
- check out the [Salsa book](https://salsa-rs.github.io/salsa);
- [中文版](https://rust-chinese-translation.github.io/salsa-book)
- watch one of our [videos](https://salsa-rs.github.io/salsa/videos.html).
## Getting in touch
The bulk of the discussion happens in the [issues](https://github.com/salsa-rs/salsa/issues)
and [pull requests](https://github.com/salsa-rs/salsa/pulls),
but we have a [zulip chat](https://salsa.zulipchat.com/) as well.
## Contributing
To create a release and publish to crates.io, update the `version` field in Cargo.toml.
After pushed, GitHub Actions will publish the crates to crates.io automatically.
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/RELEASES.md 0000664 0000000 0000000 00000001213 15077662435 0021367 0 ustar 00root root 0000000 0000000 # 0.13.0
- **Breaking change:** adopt the new `Durability` API proposed in [RFC #6]
- this replaces and generalizes the existing concepts of constants
- **Breaking change:** remove "volatile" queries
- instead, create a normal query which invokes the
`report_untracked_read` method on the salsa runtime
- introduce "slots", an optimization to salsa's internal workings
- document `#[salsa::requires]` attribute, which permits private dependencies
- Adopt `AtomicU64` for `runtimeId` (#182)
- use `ptr::eq` and `ptr::hash` for readability
- upgrade parking lot, rand dependencies
[RFC #6]: https://github.com/salsa-rs/salsa-rfcs/pull/6
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/benches/ 0000775 0000000 0000000 00000000000 15077662435 0021254 5 ustar 00root root 0000000 0000000 salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/benches/accumulator.rs 0000664 0000000 0000000 00000003614 15077662435 0024145 0 ustar 00root root 0000000 0000000 use std::hint::black_box;
use codspeed_criterion_compat::{criterion_group, criterion_main, BatchSize, Criterion};
use salsa::Accumulator;
#[salsa::input]
struct Input {
expressions: usize,
}
#[allow(dead_code)]
#[salsa::accumulator]
struct Diagnostic(String);
#[salsa::interned]
struct Expression<'db> {
number: usize,
}
#[salsa::tracked]
#[inline(never)]
fn root<'db>(db: &'db dyn salsa::Database, input: Input) -> Vec {
(0..input.expressions(db))
.map(|i| infer_expression(db, Expression::new(db, i)))
.collect()
}
#[salsa::tracked]
#[inline(never)]
fn infer_expression<'db>(db: &'db dyn salsa::Database, expression: Expression<'db>) -> usize {
let number = expression.number(db);
if number % 10 == 0 {
Diagnostic(format!("Number is {number}")).accumulate(db);
}
if number != 0 && number % 2 == 0 {
let sub_expression = Expression::new(db, number / 2);
let _ = infer_expression(db, sub_expression);
}
number
}
fn accumulator(criterion: &mut Criterion) {
criterion.bench_function("accumulator", |b| {
b.iter_batched_ref(
|| {
let db = salsa::DatabaseImpl::new();
let input = Input::new(black_box(&db), black_box(10_000));
// Pre-warm
let result = root(black_box(&db), black_box(input));
assert!(!black_box(result).is_empty());
(db, input)
},
|(db, input)| {
// Measure the cost of collecting accumulators ignoring the cost of running the
// query itself.
let diagnostics = root::accumulated::(black_box(db), *black_box(input));
assert_eq!(black_box(diagnostics).len(), 1000);
},
BatchSize::SmallInput,
);
});
}
criterion_group!(benches, accumulator);
criterion_main!(benches);
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/benches/compare.rs 0000664 0000000 0000000 00000021300 15077662435 0023244 0 ustar 00root root 0000000 0000000 use std::hint::black_box;
use std::mem::transmute;
use codspeed_criterion_compat::{
criterion_group, criterion_main, BatchSize, BenchmarkId, Criterion,
};
use salsa::Setter;
#[salsa::input]
pub struct Input {
#[returns(ref)]
pub text: String,
}
#[salsa::tracked]
#[inline(never)]
pub fn length(db: &dyn salsa::Database, input: Input) -> usize {
input.text(db).len()
}
#[salsa::interned]
pub struct InternedInput<'db> {
#[returns(ref)]
pub text: String,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, salsa::Supertype)]
enum SupertypeInput<'db> {
InternedInput(InternedInput<'db>),
Input(Input),
}
#[salsa::tracked]
#[inline(never)]
pub fn interned_length<'db>(db: &'db dyn salsa::Database, input: InternedInput<'db>) -> usize {
input.text(db).len()
}
#[salsa::tracked]
#[inline(never)]
pub fn either_length<'db>(db: &'db dyn salsa::Database, input: SupertypeInput<'db>) -> usize {
match input {
SupertypeInput::InternedInput(input) => interned_length(db, input),
SupertypeInput::Input(input) => length(db, input),
}
}
fn mutating_inputs(c: &mut Criterion) {
let mut group: codspeed_criterion_compat::BenchmarkGroup<
codspeed_criterion_compat::measurement::WallTime,
> = c.benchmark_group("Mutating Inputs");
for n in &[10, 20, 30] {
group.bench_function(BenchmarkId::new("mutating", n), |b| {
b.iter_batched_ref(
|| {
let db = salsa::DatabaseImpl::default();
let base_string = "hello, world!".to_owned();
let base_len = base_string.len();
let string = base_string.clone().repeat(*n);
let new_len = string.len();
let input = Input::new(black_box(&db), black_box(base_string.clone()));
let actual_len = length(&db, input);
assert_eq!(black_box(actual_len), base_len);
(db, input, string, new_len)
},
|&mut (ref mut db, input, ref string, new_len)| {
input.set_text(black_box(db)).to(black_box(string).clone());
let actual_len = length(db, input);
assert_eq!(black_box(actual_len), new_len);
},
BatchSize::SmallInput,
)
});
}
group.finish();
}
fn inputs(c: &mut Criterion) {
let mut group: codspeed_criterion_compat::BenchmarkGroup<
codspeed_criterion_compat::measurement::WallTime,
> = c.benchmark_group("Mutating Inputs");
group.bench_function(BenchmarkId::new("new", "InternedInput"), |b| {
b.iter_batched_ref(
|| {
let db = salsa::DatabaseImpl::default();
// Prepopulate ingredients.
let input =
InternedInput::new(black_box(&db), black_box("hello, world!".to_owned()));
let interned_len = interned_length(black_box(&db), black_box(input));
assert_eq!(black_box(interned_len), 13);
db
},
|db| {
let input =
InternedInput::new(black_box(db), black_box("hello, world!".to_owned()));
let interned_len = interned_length(black_box(db), black_box(input));
assert_eq!(black_box(interned_len), 13);
},
BatchSize::SmallInput,
)
});
group.bench_function(BenchmarkId::new("amortized", "InternedInput"), |b| {
b.iter_batched_ref(
|| {
let db = salsa::DatabaseImpl::default();
// we can't pass this along otherwise, and the lifetime is generally informational
let input: InternedInput<'static> =
unsafe { transmute(InternedInput::new(&db, "hello, world!".to_owned())) };
let interned_len = interned_length(black_box(&db), black_box(input));
assert_eq!(black_box(interned_len), 13);
(db, input)
},
|&mut (ref db, input)| {
let interned_len = interned_length(black_box(db), black_box(input));
assert_eq!(black_box(interned_len), 13);
},
BatchSize::SmallInput,
)
});
group.bench_function(BenchmarkId::new("new", "Input"), |b| {
b.iter_batched_ref(
|| {
let db = salsa::DatabaseImpl::default();
// Prepopulate ingredients.
let input = Input::new(black_box(&db), black_box("hello, world!".to_owned()));
let len = length(black_box(&db), black_box(input));
assert_eq!(black_box(len), 13);
db
},
|db| {
let input = Input::new(black_box(db), black_box("hello, world!".to_owned()));
let len = length(black_box(db), black_box(input));
assert_eq!(black_box(len), 13);
},
BatchSize::SmallInput,
)
});
group.bench_function(BenchmarkId::new("amortized", "Input"), |b| {
b.iter_batched_ref(
|| {
let db = salsa::DatabaseImpl::default();
let input = Input::new(black_box(&db), black_box("hello, world!".to_owned()));
let len = length(black_box(&db), black_box(input));
assert_eq!(black_box(len), 13);
(db, input)
},
|&mut (ref db, input)| {
let len = length(black_box(db), black_box(input));
assert_eq!(black_box(len), 13);
},
BatchSize::SmallInput,
)
});
group.bench_function(BenchmarkId::new("new", "SupertypeInput"), |b| {
b.iter_batched_ref(
|| {
let db = salsa::DatabaseImpl::default();
// Prepopulate ingredients.
let input = SupertypeInput::Input(Input::new(
black_box(&db),
black_box("hello, world!".to_owned()),
));
let interned_input = SupertypeInput::InternedInput(InternedInput::new(
black_box(&db),
black_box("hello, world!".to_owned()),
));
let len = either_length(black_box(&db), black_box(input));
assert_eq!(black_box(len), 13);
let len = either_length(black_box(&db), black_box(interned_input));
assert_eq!(black_box(len), 13);
db
},
|db| {
let input = SupertypeInput::Input(Input::new(
black_box(db),
black_box("hello, world!".to_owned()),
));
let interned_input = SupertypeInput::InternedInput(InternedInput::new(
black_box(db),
black_box("hello, world!".to_owned()),
));
let len = either_length(black_box(db), black_box(input));
assert_eq!(black_box(len), 13);
let len = either_length(black_box(db), black_box(interned_input));
assert_eq!(black_box(len), 13);
},
BatchSize::SmallInput,
)
});
group.bench_function(BenchmarkId::new("amortized", "SupertypeInput"), |b| {
b.iter_batched_ref(
|| {
let db = salsa::DatabaseImpl::default();
let input = SupertypeInput::Input(Input::new(
black_box(&db),
black_box("hello, world!".to_owned()),
));
let interned_input = SupertypeInput::InternedInput(InternedInput::new(
black_box(&db),
black_box("hello, world!".to_owned()),
));
// we can't pass this along otherwise, and the lifetime is generally informational
let interned_input: SupertypeInput<'static> = unsafe { transmute(interned_input) };
let len = either_length(black_box(&db), black_box(input));
assert_eq!(black_box(len), 13);
let len = either_length(black_box(&db), black_box(interned_input));
assert_eq!(black_box(len), 13);
(db, input, interned_input)
},
|&mut (ref db, input, interned_input)| {
let len = either_length(black_box(db), black_box(input));
assert_eq!(black_box(len), 13);
let len = either_length(black_box(db), black_box(interned_input));
assert_eq!(black_box(len), 13);
},
BatchSize::SmallInput,
)
});
group.finish();
}
criterion_group!(benches, mutating_inputs, inputs);
criterion_main!(benches);
salsa-cdd0b85516a52c18b8a6d17a2279a96ed6c3e198/benches/dataflow.rs 0000664 0000000 0000000 00000015553 15077662435 0023434 0 ustar 00root root 0000000 0000000 //! Benchmark for fixpoint iteration cycle resolution.
//!
//! This benchmark simulates a (very simplified) version of a real dataflow analysis using fixpoint
//! iteration.
use std::collections::BTreeSet;
use std::iter::IntoIterator;
use codspeed_criterion_compat::{criterion_group, criterion_main, BatchSize, Criterion};
use salsa::{CycleRecoveryAction, Database as Db, Setter};
/// A Use of a symbol.
#[salsa::input]
struct Use {
reaching_definitions: Vec,
}
/// A Definition of a symbol, either of the form `base + increment` or `0 + increment`.
#[salsa::input]
struct Definition {
base: Option