Primary caching 7: Always expose the data time in query responses #4711

teh-cmc · 2024-01-05T16:28:57Z

99% grunt work, the only somewhat interesting thing happens in query_archetype

Our query model always operates with two distinct timestamps: the timestamp you're querying for (query_time) vs. the timestamp of the data you get back (data_time).

This is the result of our latest-at semantics: a query for a point at time 10 can return a point at time 2.
This is important to know when caching the data: a query at time 4 and a query at time 8 that both return the data at time 2 must share the same single entry or the memory budget would explode.

This PR just updates all existing latest-at APIs so they return the data time in their response.
This was already the case for range APIs.

Note that in the case of query_archetype, which is a compound API that emits multiple queries, the data time of the final result is the most recent data time among all of its components.

A follow-up PR will use the data time to deduplicate entries in the latest-at cache.

Part of the primary caching series of PR (index search, joins, deserialization):

Checklist

I have read and agree to Contributor Guide and the Code of Conduct
I've included a screenshot or gif (if applicable)
I have tested the web demo (if applicable):
- Using newly built examples: app.rerun.io
- Using examples from latest main build: app.rerun.io
- Using full set of examples from nightly build: app.rerun.io
The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG

crates/re_query/src/archetype_view.rs

teh-cmc · 2024-01-08T17:17:00Z

crates/re_query_cache/src/query.rs

@@ -105,7 +105,8 @@ macro_rules! impl_query_archetype {

                if bucket.is_empty() {
                    let now = web_time::Instant::now();
-                    let arch_view = query_archetype::<A>(store, &query, entity_path)?;
+                    // TODO(cmc): cache deduplication.


Implemented in Primary caching 8: implement latest-at data-time cache entry deduplication #4712

teh-cmc · 2024-01-08T17:17:18Z

crates/re_query_cache/src/query.rs

@@ -152,7 +153,7 @@ macro_rules! impl_query_archetype {

                    for (time, arch_view) in arch_views {
                        let data = (
-                            // TODO(cmc): `ArchetypeView` should indicate its pov time.
+                            // TODO(cmc): actual timeless caching support.


Implemented in Primary caching 9: timeless latest-at support #4721

teh-cmc · 2024-01-08T17:17:25Z

crates/re_query_cache/src/query.rs


                    let data = (
-                        // TODO(cmc): `ArchetypeView` should indicate its pov time.
-                        (TimeInt::MIN, arch_view.primary_row_id()),
+                        // TODO(cmc): actual timeless caching support.


Implemented in Primary caching 9: timeless latest-at support #4721

teh-cmc · 2024-01-09T10:24:12Z

crates/re_query/src/query.rs

+            get_component_with_instances(store, query, ent_path, *component).map(
+                |(data_time, _, component_result)| {
+                    max_data_time = Option::max(max_data_time, data_time);
+                    component_result
+                },
+            )


The meat of this PR.

This implements the most barebone latest-at caching support. The goal is merely to introduce all the machinery and boilerplate required to get the primary cache running, actual caching features will be implemented on top of this foundation in follow up PRs. The [existing benchmark suite](https://github.com/rerun-io/rerun/blob/790f391/crates/re_query/benches/query_benchmark.rs) has been ported as-is to the cached APIs (5950X, Arch): ``` group primcache_3_vanilla primcache_3_cached ----- ------------------- ------------------ arrow_batch_points2/insert 1.02 1015.0±11.07µs 939.6 MElem/sec 1.00 1000.0±7.37µs 953.7 MElem/sec arrow_batch_points2/query 2.90 3.4±0.02µs 276.5 MElem/sec 1.00 1190.5±41.55ns 801.0 MElem/sec arrow_batch_strings2/insert 1.00 1045.7±7.85µs 912.0 MElem/sec 1.00 1042.1±14.01µs 915.1 MElem/sec arrow_batch_strings2/query 1.91 21.3±0.17µs 44.7 MElem/sec 1.00 11.2±0.04µs 85.2 MElem/sec arrow_mono_points2/insert 1.01 1789.2±3.40ms 545.8 KElem/sec 1.00 1773.6±23.00ms 550.6 KElem/sec arrow_mono_points2/query 6.78 1102.4±18.79µs 885.9 KElem/sec 1.00 162.6±3.39µs 5.9 MElem/sec arrow_mono_strings2/insert 1.00 1777.3±5.89ms 549.5 KElem/sec 1.00 1777.3±7.53ms 549.5 KElem/sec arrow_mono_strings2/query 6.30 1149.9±15.36µs 849.3 KElem/sec 1.00 182.5±0.41µs 5.2 MElem/sec ``` --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726

Make it possible to toggle primary caching on and off at runtime, for both latest-at and range queries. ![image](https://github.com/rerun-io/rerun/assets/2910679/46404d8d-ea27-441c-9bae-ba5e3476adef) --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726

Integrates the cached APIs with the 2D & 3D spatial views, which is a pretty tough thing to do because there's a lot of abstraction going on in there. `main` vs. cache disabled vs. cache enable (5950X, Arch): ``` group main primcache_5_uncached primcache_5_cached ----- ---- -------------------- ------------------ Points3D/load_all 1.68 10.1±0.14ms 94.2 MElem/sec 1.00 6.0±0.07ms 157.9 MElem/sec 1.01 6.1±0.06ms 155.7 MElem/sec Points3D/load_colors 1.44 3.8±0.02ms 252.6 MElem/sec 1.00 2.6±0.05ms 364.0 MElem/sec 1.07 2.8±0.06ms 339.5 MElem/sec Points3D/load_picking_ids 15.16 1859.6±7.01µs 512.9 MElem/sec 1.01 124.3±3.92µs 7.5 GElem/sec 1.00 122.7±3.86µs 7.6 GElem/sec Points3D/load_positions 2.29 420.1±0.76µs 2.2 GElem/sec 1.03 189.3±7.44µs 4.9 GElem/sec 1.00 183.4±5.56µs 5.1 GElem/sec Points3D/load_radii 1.46 3.3±0.04ms 290.1 MElem/sec 1.05 2.4±0.03ms 404.8 MElem/sec 1.00 2.2±0.00ms 423.9 MElem/sec Points3D/query_archetype 2.51 676.1±7.59ns ? ?/sec 15859.98 4.3±0.06ms ? ?/sec 1.00 268.9±3.39ns ? ?/sec ``` --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726

Integrates the cached APIs with the TextLog & TimeSeries views, which is pretty trivial. This of course does nothing, since the cache doesn't cache range queries yet. --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726

…ation (#4712) Introduces the notion of cache deduplication: given a query at time `4` and a query at time `8` that both returns data at time `2`, they must share a single cache entry. I.e. starting with this PR, scrubbing through the OPF example will not result if more cache memory being used. --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726 - #4773 - #4784 - #4785 - #4793 - #4800

Introduces a dedicated cache bucket for timeless data and properly forwards the information through all APIs downstream. --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726 - #4773 - #4784 - #4785 - #4793 - #4800

This implements cache invalidation via a `StoreSubscriber`. We keep track of the timestamps to invalidate in the `StoreSubscriber`, but we only do the actual removal of components at query time. This is similar to how we handle bucket sorting in the main store: doing it at query time has the benefit that the frame time effectively behaves as natural micro-batching mechanism that vastly improves performance. --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726 - #4773 - #4784 - #4785 - #4793 - #4800

) The primary cache now tracks memory statistics and display them in the memory panel. This immediately highlights a very stupid thing that the cache does: missing optional components that have been turned into streams of default values by the `ArchetypeView` are materialized as such :man_facepalming: - #4779 https://github.com/rerun-io/rerun/assets/2910679/876b264a-3f77-4d91-934e-aa8897bb32fe - Fixes #4730 --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726 - #4773 - #4784 - #4785 - #4793 - #4800

**Prefer on a per-commit basis, stuff has moved around** Range queries are back!... in the most primitive form possible. No invalidation, no bucketing, no optimization, no nothing. Just putting everything in place. https://github.com/rerun-io/rerun/assets/2910679/a65281e4-9843-4598-9547-ce7e45197995 --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726 - #4773 - #4784 - #4785 - #4793 - #4800

#4785) Title. https://github.com/rerun-io/rerun/assets/2910679/cf2c2748-a461-49fe-8124-c2a94164c956 --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726 - #4773 - #4784 - #4785 - #4793 - #4800

… range queries (#4793) Our low-level range APIs used to bake the latest-at results at `range.min - 1` into the range results, which is a big problem in a multi tenant setting because `range(1, 10)` vs. `latestat(1) + range(2, 10)` are two completely different things. Side-effect: a plot with a window of len 1 now behaves as expected: https://github.com/rerun-io/rerun/assets/2910679/957ac367-35a6-4bea-9f40-59d51c556639 --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726 - #4773 - #4784 - #4785 - #4793 - #4800

The most obvious and most important performance optimization when doing cached range queries: only upsert data at the edges of the bucket / ring-buffer. This works because our buckets (well, singular, at the moment) are always dense. - #4793 ![image](https://github.com/rerun-io/rerun/assets/2910679/7246827c-4977-4b3f-9ef9-f8e96b8a9bea) - #4800: ![image](https://github.com/rerun-io/rerun/assets/2910679/ab78643b-a98b-4568-b510-2b8827467095) --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726 - #4773 - #4784 - #4785 - #4793 - #4800

Range queries used to A) return the frame a T-1, B) accumulate state starting at T-1 and then C) yield frames starting at T. A) was a huge issue for many reasons, which #4793 took care of by eliminating both A) and B). But we need B) for range queries to be context-free, i.e. to be guaranteed that `Range(5, 10)` and `Range(4, 10)` will return the exact same data for frame `5`. This is crucial for multi-tenant settings where those 2 example queries would share the same cache. It also is the nicer-nicer version of the range semantics that we wanted anyway, I just didn't realize back then that it would require so little changes, or I would've gone straight for that. --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726 - #4773 - #4784 - #4785 - #4793 - #4800 - #4851 - #4852 - #4853 - #4856

Simply add a timeless path for the range cache, and actually only iterate over the range the user asked for (we were still blindly iterating over everything until now). Also some very minimal clean up related to #4832, but we have a long way to go... - #4832 --- - Fixes #4821 --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726 - #4773 - #4784 - #4785 - #4793 - #4800 - #4851 - #4852 - #4853 - #4856

Implement range invalidation and do a quality pass over all the size tracking stuff in the cache. **Range caching is now enabled by default!** - Fixes #4809 - Fixes #374 --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726 - #4773 - #4784 - #4785 - #4793 - #4800 - #4851 - #4852 - #4853 - #4856

- Quick sanity pass over all the intermediary locks and refcounts to make sure we don't hold anything for longer than we need. - Get rid of all static globals and let the caches live with their associated stores in `EntityDb`. - `CacheKey` no longer requires a `StoreId`. --- - Fixes #4815 --- Part of the primary caching series of PR (index search, joins, deserialization): - #4592 - #4593 - #4659 - #4680 - #4681 - #4698 - #4711 - #4712 - #4721 - #4726 - #4773 - #4784 - #4785 - #4793 - #4800 - #4851 - #4852 - #4853 - #4856

teh-cmc added 🔍 re_query affects re_query itself 📉 performance Optimization, memory use, etc do-not-merge Do not merge this PR exclude from changelog PRs with this won't show up in CHANGELOG.md labels Jan 5, 2024

teh-cmc changed the title ~~Primary caching 7: Always expose the _data_ time in query responses~~ Primary caching 7: Always expose the *data* time in query responses Jan 5, 2024

teh-cmc changed the title ~~Primary caching 7: Always expose the *data* time in query responses~~ Primary caching 7: Always expose the data time in query responses Jan 5, 2024

teh-cmc force-pushed the cmc/primcache_6_series branch from 2803862 to de76817 Compare January 8, 2024 16:28

teh-cmc force-pushed the cmc/primcache_7_data_time branch from bcc7ab9 to 035a111 Compare January 8, 2024 16:59

teh-cmc commented Jan 8, 2024

View reviewed changes

teh-cmc marked this pull request as ready for review January 8, 2024 17:20

teh-cmc marked this pull request as draft January 8, 2024 17:46

teh-cmc force-pushed the cmc/primcache_7_data_time branch from 64f9cf4 to 88989df Compare January 9, 2024 10:19

teh-cmc commented Jan 9, 2024

View reviewed changes

teh-cmc marked this pull request as ready for review January 9, 2024 10:24

teh-cmc mentioned this pull request Jan 10, 2024

Primary caching 11: cache stats and integration with memory panel #4773

Merged

4 tasks

teh-cmc force-pushed the cmc/primcache_6_series branch from de76817 to f23f605 Compare January 10, 2024 16:08

Base automatically changed from cmc/primcache_6_series to main January 10, 2024 16:13

teh-cmc mentioned this pull request Jan 12, 2024

Primary caching 15: range read performance optimization #4800

Merged

4 tasks

teh-cmc force-pushed the cmc/primcache_7_data_time branch from 3482fc3 to b955acc Compare January 15, 2024 09:23

emilk approved these changes Jan 15, 2024

View reviewed changes

teh-cmc added 5 commits January 15, 2024 10:30

latest_at now returns the _data_ time too

92af381

archetype queries now always return the data time too

3fdb07c

self-review

1d0f1e1

bake datatime into VersionedComponent

814933e

bake data_time into archetypeview

6921781

teh-cmc force-pushed the cmc/primcache_7_data_time branch from b955acc to 6921781 Compare January 15, 2024 09:36

teh-cmc merged commit 8dd1681 into main Jan 15, 2024
30 of 31 checks passed

teh-cmc deleted the cmc/primcache_7_data_time branch January 15, 2024 09:39

teh-cmc removed the do-not-merge Do not merge this PR label Jan 15, 2024

This was referenced Jan 18, 2024

Primary caching 16: context-free range semantics #4851

Merged

Primary caching 17: timeless range #4852

Merged

Primary caching 18: range invalidation (ENABLED BY DEFAULT 🎊) #4853

Merged

Primary caching 19 (final): de-staticify cache globals #4856

Merged

teh-cmc added include in changelog and removed exclude from changelog PRs with this won't show up in CHANGELOG.md labels Feb 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Primary caching 7: Always expose the data time in query responses #4711

Primary caching 7: Always expose the data time in query responses #4711

teh-cmc commented Jan 5, 2024 •

edited by github-actions bot

Loading

teh-cmc Jan 8, 2024

teh-cmc Jan 8, 2024

teh-cmc Jan 8, 2024

teh-cmc Jan 9, 2024

Primary caching 7: Always expose the data time in query responses #4711

Primary caching 7: Always expose the data time in query responses #4711

Conversation

teh-cmc commented Jan 5, 2024 • edited by github-actions bot Loading

Checklist

teh-cmc Jan 8, 2024

Choose a reason for hiding this comment

teh-cmc Jan 8, 2024

Choose a reason for hiding this comment

teh-cmc Jan 8, 2024

Choose a reason for hiding this comment

teh-cmc Jan 9, 2024

Choose a reason for hiding this comment

teh-cmc commented Jan 5, 2024 •

edited by github-actions bot

Loading