1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
#![warn(rust_2018_idioms)]
#![warn(missing_docs)]
#![allow(dead_code)]
//! The salsa crate is a crate for incremental recomputation. It
//! permits you to define a "database" of queries with both inputs and
//! values derived from those inputs; as you set the inputs, you can
//! re-execute the derived queries and it will try to re-use results
//! from previous invocations as appropriate.
mod derived;
mod input;
mod runtime;
pub mod debug;
/// Items in this module are public for implementation reasons,
/// and are exempt from the SemVer guarantees.
#[doc(hidden)]
pub mod plumbing;
use crate::plumbing::CycleDetected;
use crate::plumbing::InputQueryStorageOps;
use crate::plumbing::QueryStorageMassOps;
use crate::plumbing::QueryStorageOps;
use crate::plumbing::UncheckedMutQueryStorageOps;
use derive_new::new;
use std::fmt::{self, Debug};
use std::hash::Hash;
pub use crate::runtime::Runtime;
pub use crate::runtime::RuntimeId;
/// The base trait which your "query context" must implement. Gives
/// access to the salsa runtime, which you must embed into your query
/// context (along with whatever other state you may require).
pub trait Database: plumbing::DatabaseStorageTypes + plumbing::DatabaseOps {
/// Gives access to the underlying salsa runtime.
fn salsa_runtime(&self) -> &Runtime<Self>;
/// Iterates through all query storage and removes any values that
/// have not been used since the last revision was created. The
/// intended use-cycle is that you first execute all of your
/// "main" queries; this will ensure that all query values they
/// consume are marked as used. You then invoke this method to
/// remove other values that were not needed for your main query
/// results.
fn sweep_all(&self, strategy: SweepStrategy) {
self.salsa_runtime().sweep_all(self, strategy);
}
/// Get access to extra methods pertaining to a given query. For
/// example, you can use this to run the GC (`sweep`) across a
/// single input. You can also use it to invoke a query, though
/// it's more common to use the trait method on the database
/// itself.
#[allow(unused_variables)]
fn query<Q>(&self, query: Q) -> QueryTable<'_, Self, Q>
where
Q: Query<Self>,
Self: plumbing::GetQueryTable<Q>,
{
<Self as plumbing::GetQueryTable<Q>>::get_query_table(self)
}
/// Like `query`, but gives access to methods for setting the
/// value of an input.
///
/// # Threads, cancellation, and blocking
///
/// Mutating the value of a query cannot be done while there are
/// still other queries executing. If you are using your database
/// within a single thread, this is not a problem: you only have
/// `&self` access to the database, but this method requires `&mut
/// self`.
///
/// However, if you have used `snapshot` to create other threads,
/// then attempts to `set` will **block the current thread** until
/// those snapshots are dropped (usually when those threads
/// complete). This also implies that if you create a snapshot but
/// do not send it to another thread, then invoking `set` will
/// deadlock.
///
/// Before blocking, the thread that is attempting to `set` will
/// also set a cancellation flag. In the threads operating on
/// snapshots, you can use the [`is_current_revision_canceled`]
/// method to check for this flag and bring those operations to a
/// close, thus allowing the `set` to succeed. Ignoring this flag
/// may lead to "starvation", meaning that the thread attempting
/// to `set` has to wait a long, long time. =)
///
/// [`is_current_revision_canceled`]: struct.Runtime.html#method.is_current_revision_canceled
#[allow(unused_variables)]
fn query_mut<Q>(&mut self, query: Q) -> QueryTableMut<'_, Self, Q>
where
Q: Query<Self>,
Self: plumbing::GetQueryTable<Q>,
{
<Self as plumbing::GetQueryTable<Q>>::get_query_table_mut(self)
}
/// This function is invoked at key points in the salsa
/// runtime. It permits the database to be customized and to
/// inject logging or other custom behavior.
fn salsa_event(&self, event_fn: impl Fn() -> Event<Self>) {
#![allow(unused_variables)]
}
}
/// The `Event` struct identifies various notable things that can
/// occur during salsa execution. Instances of this struct are given
/// to `salsa_event`.
pub struct Event<DB: Database> {
/// The id of the snapshot that triggered the event. Usually
/// 1-to-1 with a thread, as well.
pub runtime_id: RuntimeId,
/// What sort of event was it.
pub kind: EventKind<DB>,
}
impl<DB: Database> fmt::Debug for Event<DB> {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt.debug_struct("Event")
.field("runtime_id", &self.runtime_id)
.field("kind", &self.kind)
.finish()
}
}
/// An enum identifying the various kinds of events that can occur.
pub enum EventKind<DB: Database> {
/// Occurs when we found that all inputs to a memoized value are
/// up-to-date and hence the value can be re-used without
/// executing the closure.
///
/// Executes before the "re-used" value is returned.
DidValidateMemoizedValue {
/// The descriptor for the affected value. Implements `Debug`.
descriptor: DB::QueryDescriptor,
},
/// Indicates that another thread (with id `other_runtime_id`) is processing the
/// given query (`descriptor`), so we will block until they
/// finish.
///
/// Executes after we have registered with the other thread but
/// before they have answered us.
///
/// (NB: you can find the `id` of the current thread via the
/// `salsa_runtime`)
WillBlockOn {
/// The id of the runtime we will block on.
other_runtime_id: RuntimeId,
/// The descriptor for the affected value. Implements `Debug`.
descriptor: DB::QueryDescriptor,
},
/// Indicates that the input value will change after this
/// callback, e.g. due to a call to `set`.
WillChangeInputValue {
/// The descriptor for the affected value. Implements `Debug`.
descriptor: DB::QueryDescriptor,
},
/// Indicates that the function for this query will be executed.
/// This is either because it has never executed before or because
/// its inputs may be out of date.
WillExecute {
/// The descriptor for the affected value. Implements `Debug`.
descriptor: DB::QueryDescriptor,
},
}
impl<DB: Database> fmt::Debug for EventKind<DB> {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
EventKind::DidValidateMemoizedValue { descriptor } => fmt
.debug_struct("DidValidateMemoizedValue")
.field("descriptor", descriptor)
.finish(),
EventKind::WillBlockOn {
other_runtime_id,
descriptor,
} => fmt
.debug_struct("WillBlockOn")
.field("other_runtime_id", other_runtime_id)
.field("descriptor", descriptor)
.finish(),
EventKind::WillChangeInputValue { descriptor } => fmt
.debug_struct("WillChangeInputValue")
.field("descriptor", descriptor)
.finish(),
EventKind::WillExecute { descriptor } => fmt
.debug_struct("WillExecute")
.field("descriptor", descriptor)
.finish(),
}
}
}
/// The sweep strategy controls what data we will keep/discard when we
/// do a GC-sweep. The default (`SweepStrategy::default`) is to keep
/// all memoized values used in the current revision.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub struct SweepStrategy {
keep_values: bool,
}
impl SweepStrategy {
/// Causes us to discard memoized *values* but keep the
/// *dependencies*. This means you will have to recompute the
/// results from any queries you execute but does permit you to
/// quickly determine if a value is still up to date.
pub fn discard_values(self) -> SweepStrategy {
SweepStrategy {
keep_values: false,
..self
}
}
}
impl Default for SweepStrategy {
fn default() -> Self {
SweepStrategy { keep_values: true }
}
}
/// Indicates a database that also supports parallel query
/// evaluation. All of Salsa's base query support is capable of
/// parallel execution, but for it to work, your query key/value types
/// must also be `Send`, as must any additional data in your database.
pub trait ParallelDatabase: Database + Send {
/// Creates a second handle to the database that holds the
/// database fixed at a particular revision. So long as this
/// "frozen" handle exists, any attempt to [`set`] an input will
/// block.
///
/// [`set`]: struct.QueryTable.html#method.set
///
/// This is the method you are meant to use most of the time in a
/// parallel setting where modifications may arise asynchronously
/// (e.g., a language server). In this context, it is common to
/// wish to "fork off" a snapshot of the database performing some
/// series of queries in parallel and arranging the results. Using
/// this method for that purpose ensures that those queries will
/// see a consistent view of the database (it is also advisable
/// for those queries to use the [`is_current_revision_canceled`]
/// method to check for cancellation).
///
/// [`is_current_revision_canceled`]: struct.Runtime.html#method.is_current_revision_canceled
///
/// # Panics
///
/// It is not permitted to create a snapshot from inside of a
/// query. Attepting to do so will panic.
///
/// # Deadlock warning
///
/// The intended pattern for snapshots is that, once created, they
/// are sent to another thread and used from there. As such, the
/// `snapshot` acquires a "read lock" on the database --
/// therefore, so long as the `snapshot` is not dropped, any
/// attempt to `set` a value in the database will block. If the
/// `snapshot` is owned by the same thread that is attempting to
/// `set`, this will cause a problem.
///
/// # How to implement this
///
/// Typically, this method will create a second copy of your
/// database type (`MyDatabaseType`, in the example below),
/// cloning over each of the fields from `self` into this new
/// copy. For the field that stores the salsa runtime, you should
/// use [the `Runtime::snapshot` method][rfm] to create a snapshot of the
/// runtime. Finally, package up the result using `Snapshot::new`,
/// which is a simple wrapper type that only gives `&self` access
/// to the database within (thus preventing the use of methods
/// that may mutate the inputs):
///
/// [rfm]: struct.Runtime.html#method.snapshot
///
/// ```rust,ignore
/// impl ParallelDatabase for MyDatabaseType {
/// fn snapshot(&self) -> Snapshot<Self> {
/// Snapshot::new(
/// MyDatabaseType {
/// runtime: self.runtime.snapshot(self),
/// other_field: self.other_field.clone(),
/// }
/// )
/// }
/// }
/// ```
fn snapshot(&self) -> Snapshot<Self>;
}
/// Simple wrapper struct that takes ownership of a database `DB` and
/// only gives `&self` access to it. See [the `snapshot` method][fm]
/// for more details.
///
/// [fm]: trait.ParallelDatabase#method.snapshot
#[derive(Debug)]
pub struct Snapshot<DB>
where
DB: ParallelDatabase,
{
db: DB,
}
impl<DB> Snapshot<DB>
where
DB: ParallelDatabase,
{
/// Creates a `Snapshot` that wraps the given database handle
/// `db`. From this point forward, only shared references to `db`
/// will be possible.
pub fn new(db: DB) -> Self {
Snapshot { db }
}
}
impl<DB> std::ops::Deref for Snapshot<DB>
where
DB: ParallelDatabase,
{
type Target = DB;
fn deref(&self) -> &DB {
&self.db
}
}
/// Trait implements by all of the "special types" associated with
/// each of your queries.
pub trait Query<DB: Database>: Debug + Default + Sized + 'static {
/// Type that you you give as a parameter -- for queries with zero
/// or more than one input, this will be a tuple.
type Key: Clone + Debug + Hash + Eq;
/// What value does the query return?
type Value: Clone + Debug;
/// Internal struct storing the values for the query.
type Storage: plumbing::QueryStorageOps<DB, Self> + Send + Sync;
}
/// Return value from [the `query` method] on `Database`.
/// Gives access to various less common operations on queries.
///
/// [the `query_mut` method]: trait.Database#method.query
#[derive(new)]
pub struct QueryTable<'me, DB, Q>
where
DB: plumbing::GetQueryTable<Q>,
Q: Query<DB> + 'me,
{
db: &'me DB,
storage: &'me Q::Storage,
}
impl<DB, Q> QueryTable<'_, DB, Q>
where
DB: plumbing::GetQueryTable<Q>,
Q: Query<DB>,
{
/// Execute the query on a given input. Usually it's easier to
/// invoke the trait method directly. Note that for variadic
/// queries (those with no inputs, or those with more than one
/// input) the key will be a tuple.
pub fn get(&self, key: Q::Key) -> Q::Value {
let descriptor = self.descriptor(&key);
self.storage
.try_fetch(self.db, &key, &descriptor)
.unwrap_or_else(|CycleDetected| {
self.db.salsa_runtime().report_unexpected_cycle(descriptor)
})
}
/// Remove all values for this query that have not been used in
/// the most recent revision.
pub fn sweep(&self, strategy: SweepStrategy)
where
Q::Storage: plumbing::QueryStorageMassOps<DB>,
{
self.storage.sweep(self.db, strategy);
}
fn descriptor(&self, key: &Q::Key) -> DB::QueryDescriptor {
<DB as plumbing::GetQueryTable<Q>>::descriptor(&self.db, key.clone())
}
}
/// Return value from [the `query_mut` method] on `Database`.
/// Gives access to the `set` method, notably, that is used to
/// set the value of an input query.
///
/// [the `query_mut` method]: trait.Database#method.query_mut
#[derive(new)]
pub struct QueryTableMut<'me, DB, Q>
where
DB: plumbing::GetQueryTable<Q>,
Q: Query<DB> + 'me,
{
db: &'me DB,
storage: &'me Q::Storage,
}
impl<DB, Q> QueryTableMut<'_, DB, Q>
where
DB: plumbing::GetQueryTable<Q>,
Q: Query<DB>,
{
fn descriptor(&self, key: &Q::Key) -> DB::QueryDescriptor {
<DB as plumbing::GetQueryTable<Q>>::descriptor(&self.db, key.clone())
}
/// Assign a value to an "input query". Must be used outside of
/// an active query computation.
///
/// If you are using `snapshot`, see the notes on blocking
/// and cancellation on [the `query_mut` method].
///
/// [the `query_mut` method]: trait.Database#method.query_mut
pub fn set(&self, key: Q::Key, value: Q::Value)
where
Q::Storage: plumbing::InputQueryStorageOps<DB, Q>,
{
self.storage
.set(self.db, &key, &self.descriptor(&key), value);
}
/// Assign a value to an "input query", with the additional
/// promise that this value will **never change**. Must be used
/// outside of an active query computation.
///
/// If you are using `snapshot`, see the notes on blocking
/// and cancellation on [the `query_mut` method].
///
/// [the `query_mut` method]: trait.Database#method.query_mut
pub fn set_constant(&self, key: Q::Key, value: Q::Value)
where
Q::Storage: plumbing::InputQueryStorageOps<DB, Q>,
{
self.storage
.set_constant(self.db, &key, &self.descriptor(&key), value);
}
/// Assigns a value to the query **bypassing the normal
/// incremental checking** -- this value becomes the value for the
/// query in the current revision. This can even be used on
/// "derived" queries (so long as their results are memoized).
///
/// Note that once `set_unchecked` is used, the result is
/// effectively "fixed" for all future revisions. This "mocking"
/// system is pretty primitive and subject to revision; see
/// [salsa-rs/salsa#34](https://github.com/salsa-rs/salsa/issues/34)
/// for more details.
///
/// **This is only meant to be used for "mocking" purposes in
/// tests** -- when testing a given query, you can use
/// `set_unchecked` to assign the values for its various inputs
/// and thus control what it sees when it executes.
pub fn set_unchecked(&self, key: Q::Key, value: Q::Value)
where
Q::Storage: plumbing::UncheckedMutQueryStorageOps<DB, Q>,
{
self.storage.set_unchecked(self.db, &key, value);
}
}
/// A macro that helps in defining the "context trait" of a given
/// module. This is a trait that defines everything that a block of
/// queries need to execute, as well as defining the queries
/// themselves that are exported for others to use.
///
/// This macro declares the "prototype" for a group of queries. It will
/// expand into a trait and a set of structs, one per query.
///
/// For each query, you give the name of the accessor method to invoke
/// the query (e.g., `my_query`, below), as well as its parameter
/// types and the output type. You also give the name for a query type
/// (e.g., `MyQuery`, below) that represents the query, and optionally
/// other details, such as its storage.
///
/// # Examples
///
/// The simplest example is something like this:
///
/// ```ignore
/// trait TypeckDatabase {
/// query_group! {
/// /// Comments or other attributes can go here
/// fn my_query(input: u32) -> u64 {
/// type MyQuery;
/// storage memoized; // optional, this is the default
/// use fn path::to::fn; // optional, default is `my_query`
/// }
///
/// /// Queries can have any number of inputs; the key type will be
/// /// a tuple of the input types, so in this case `(u32, f32)`.
/// fn other_query(input1: u32, input2: f32) -> u64 {
/// type OtherQuery;
/// }
/// }
/// }
/// ```
///
/// # Storage modes
///
/// Here are the possible storage values for each query. The default
/// is `storage memoized`.
///
/// ## Input queries
///
/// Specifying `storage input` will give you an **input
/// query**. Unlike derived queries, whose value is given by a
/// function, input queries are explicit set by doing
/// `db.query(QueryType).set(key, value)` (where `QueryType` is the
/// `type` specified for the query). Accessing a value that has not
/// yet been set will panic. Each time you invoke `set`, we assume the
/// value has changed, and so we will potentially re-execute derived
/// queries that read (transitively) from this input.
///
/// ## Derived queries
///
/// Derived queries are specified by a function.
///
/// - `storage memoized` -- The result is memoized
/// between calls. If the inputs have changed, we will recompute
/// the value, but then compare against the old memoized value,
/// which can significantly reduce the amount of recomputation
/// required in new revisions. This does require that the value
/// implements `Eq`.
/// - `storage volatile` -- indicates that the inputs are not fully
/// captured by salsa. The result will be recomputed once per revision.
/// - `storage dependencies` -- does not cache the value, so it will
/// be recomputed every time it is needed. We do track the inputs, however,
/// so if they have not changed, then things that rely on this query
/// may be known not to have changed.
#[macro_export]
macro_rules! query_group {
(
$(#[$attr:meta])* $v:vis trait $name:ident { $($t:tt)* }
) => {
$crate::query_group! {
attr[$(#[$attr])*];
headers[$v, $name, ];
tokens[{ $($t)* }];
}
};
(
$(#[$attr:meta])* $v:vis trait $name:ident : $($t:tt)*
) => {
$crate::query_group! {
attr[$(#[$attr])*];
headers[$v, $name, ];
tokens[$($t)*];
}
};
// Base case: found the trait body
(
attr[$($trait_attr:tt)*];
headers[$v:vis, $query_trait:ident, $($header:tt)*];
tokens[{
$(
$(#[$method_attr:meta])*
fn $method_name:ident($($key_name:ident: $key_ty:ty),* $(,)*) -> $value_ty:ty {
type $QueryType:ident;
$(storage $storage:tt;)* // FIXME(rust-lang/rust#48075) should be `?`
$(use fn $fn_path:path;)* // FIXME(rust-lang/rust#48075) should be `?`
}
)*
}];
) => {
$($trait_attr)* $v trait $query_trait: $($crate::plumbing::GetQueryTable<$QueryType> +)* $($header)* {
$(
$(#[$method_attr])*
fn $method_name(&self, $($key_name: $key_ty),*) -> $value_ty {
<Self as $crate::plumbing::GetQueryTable<$QueryType>>::get_query_table(self)
.get(($($key_name),*))
}
)*
}
$(
#[derive(Default, Debug)]
$v struct $QueryType;
impl<DB> $crate::Query<DB> for $QueryType
where
DB: $query_trait,
{
type Key = ($($key_ty),*);
type Value = $value_ty;
type Storage = $crate::query_group! { @storage_ty[DB, Self, $($storage)*] };
}
$crate::query_group! {
@query_fn[
storage($($storage)*);
method_name($method_name);
fn_path($($fn_path)*);
db_trait($query_trait);
query_type($QueryType);
key($($key_name: $key_ty),*);
]
}
)*
};
(
@query_fn[
storage(input);
method_name($method_name:ident);
fn_path();
$($rest:tt)*
]
) => {
// do nothing for `storage input`, presuming they did not write an explicit `use fn`
};
(
@query_fn[
storage(input);
method_name($method_name:ident);
fn_path($fn_path:path);
$($rest:tt)*
]
) => {
// error for `storage input` with an explicit `use fn`
compile_error! {
"cannot have `storage input` combined with `use fn`"
}
};
(
@query_fn[
storage($($storage:ident)*);
method_name($method_name:ident);
fn_path();
$($rest:tt)*
]
) => {
// default to `use fn $method_name`
$crate::query_group! {
@query_fn[
storage($($storage)*);
method_name($method_name);
fn_path($method_name);
$($rest)*
]
}
};
// Handle fns of one argument: once parenthesized patterns are stable on beta,
// we can remove this special case.
(
@query_fn[
storage($($storage:ident)*);
method_name($method_name:ident);
fn_path($fn_path:path);
db_trait($DbTrait:path);
query_type($QueryType:ty);
key($key_name:ident: $key_ty:ty);
]
) => {
impl<DB> $crate::plumbing::QueryFunction<DB> for $QueryType
where DB: $DbTrait
{
fn execute(db: &DB, $key_name: <Self as $crate::Query<DB>>::Key)
-> <Self as $crate::Query<DB>>::Value
{
$fn_path(db, $key_name)
}
}
};
// Handle fns of N arguments: once parenthesized patterns are stable on beta,
// we can use this code for all cases.
(
@query_fn[
storage($($storage:ident)*);
method_name($method_name:ident);
fn_path($fn_path:path);
db_trait($DbTrait:path);
query_type($QueryType:ty);
key($($key_name:ident: $key_ty:ty),*);
]
) => {
impl<DB> $crate::plumbing::QueryFunction<DB> for $QueryType
where DB: $DbTrait
{
fn execute(db: &DB, ($($key_name),*): <Self as $crate::Query<DB>>::Key)
-> <Self as $crate::Query<DB>>::Value
{
$fn_path(db, $($key_name),*)
}
}
};
// Recursive case: found some more part of the trait header.
// Keep pulling out tokens until we find the body.
(
attr[$($attr:tt)*];
headers[$($headers:tt)*];
tokens[$token:tt $($tokens:tt)*];
) => {
$crate::query_group! {
attr[$($attr)*];
headers[$($headers)* $token];
tokens[$($tokens)*];
}
};
// Generate storage type
(
// Default case:
@storage_ty[$DB:ident, $Self:ident, ]
) => {
$crate::query_group! { @storage_ty[$DB, $Self, memoized] }
};
(
@storage_ty[$DB:ident, $Self:ident, memoized]
) => {
$crate::plumbing::MemoizedStorage<$DB, $Self>
};
(
@storage_ty[$DB:ident, $Self:ident, volatile]
) => {
$crate::plumbing::VolatileStorage<$DB, $Self>
};
(
@storage_ty[$DB:ident, $Self:ident, dependencies]
) => {
$crate::plumbing::DependencyStorage<$DB, $Self>
};
(
@storage_ty[$DB:ident, $Self:ident, input]
) => {
$crate::plumbing::InputStorage<DB, Self>
};
(
@storage_ty[$DB:ident, $Self:ident, $storage:tt]
) => {
compile_error! {
"invalid storage specification"
}
};
}
/// This macro generates the "query storage" that goes into your database.
/// It requires you to list all of the query groups that you need as well
/// as the queries within those groups. The format looks like so:
///
/// ```rust,ignore
/// salsa::database_storage! {
/// struct MyDatabaseStorage for MyDatabase {
/// impl MyQueryGroup {
/// fn my_query1() for MyQuery1;
/// fn my_query2() for MyQuery2;
/// }
/// // ... other query groups go here ...
/// }
/// }
/// ```
///
/// Here, `MyDatabase` should be the name of your database type. The
/// macro will then generate a struct named `MyDatabaseStorage` that
/// is used by the [`salsa::Runtime`]. `MyQueryGroup` should be the
/// name of your query group.
///
/// See [the `hello_world` example][hw] for more details.
///
/// [`salsa::Runtime`]: struct.Runtime.html
/// [hw]: https://github.com/salsa-rs/salsa/tree/master/examples/hello_world
#[macro_export]
macro_rules! database_storage {
(
$(#[$attr:meta])*
$v:vis struct $Storage:ident for $Database:ty {
$(
impl $TraitName:path {
$(
fn $query_method:ident() for $QueryType:path;
)*
}
)*
}
) => {
#[derive(Default)]
$(#[$attr])*
$v struct $Storage {
$(
$(
$query_method: <$QueryType as $crate::Query<$Database>>::Storage,
)*
)*
}
/// Identifies a query and its key. You are not meant to name
/// this type directly or use its fields etc. It is a
/// **private query descriptor type generated by salsa** and
/// its exact structure is subject to change. Sadly, I don't
/// know any way to hide this with hygiene, so use `__`
/// instead.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
$v struct __SalsaQueryDescriptor {
kind: __SalsaQueryDescriptorKind
}
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
enum __SalsaQueryDescriptorKind {
$(
$(
$query_method(<$QueryType as $crate::Query<$Database>>::Key),
)*
)*
}
impl $crate::plumbing::DatabaseStorageTypes for $Database {
type QueryDescriptor = __SalsaQueryDescriptor;
type DatabaseStorage = $Storage;
}
impl $crate::plumbing::DatabaseOps for $Database {
fn for_each_query(
&self,
mut op: impl FnMut(&dyn $crate::plumbing::QueryStorageMassOps<Self>),
) {
$(
$(
op(&$crate::Database::salsa_runtime(self)
.storage()
.$query_method);
)*
)*
}
}
impl $crate::plumbing::QueryDescriptor<$Database> for __SalsaQueryDescriptor {
fn maybe_changed_since(
&self,
db: &$Database,
revision: $crate::plumbing::Revision,
) -> bool {
match &self.kind {
$(
$(
__SalsaQueryDescriptorKind::$query_method(key) => {
let runtime = $crate::Database::salsa_runtime(db);
let storage = &runtime.storage().$query_method;
<_ as $crate::plumbing::QueryStorageOps<$Database, $QueryType>>::maybe_changed_since(
storage,
db,
revision,
key,
self,
)
}
)*
)*
}
}
}
$(
impl $TraitName for $Database { }
$(
impl $crate::plumbing::GetQueryTable<$QueryType> for $Database {
fn get_query_table(
db: &Self,
) -> $crate::QueryTable<'_, Self, $QueryType> {
$crate::QueryTable::new(
db,
&$crate::Database::salsa_runtime(db)
.storage()
.$query_method,
)
}
fn get_query_table_mut(
db: &mut Self,
) -> $crate::QueryTableMut<'_, Self, $QueryType> {
let db = &*db;
$crate::QueryTableMut::new(
db,
&$crate::Database::salsa_runtime(db)
.storage()
.$query_method,
)
}
fn descriptor(
db: &Self,
key: <$QueryType as $crate::Query<Self>>::Key,
) -> <Self as $crate::plumbing::DatabaseStorageTypes>::QueryDescriptor {
__SalsaQueryDescriptor {
kind: __SalsaQueryDescriptorKind::$query_method(key),
}
}
}
)*
)*
};
}