[move-stdlib] Introduce efficient OrderedMap implementation #14872

igor-aptos · 2024-10-04T18:01:26Z

Description

Implement efficient OrderedMap implementation in move-stdlib, to replace/deprecate SimpleMap. It is an in-memory datastructure - i.e. doesn't store anything in separate resources.

Implementation is a SortedVectorMap, but given the efficiency improvements of vector operations with memcpy, it's performance characteristics are extremely good.

Running different sizes tests (these are full results), we get milliseconds needed for 100 inserts and 100 removals on maps of different sizes:

num elements  SimpleMap       OrderedMap::SortedVectorMap
10            6.4             6.8
100           25.4            10.3
1000          673.9           12.8
10000         too long        19.5

Basically achieving log(n) performance, with very simple implementation.

How Has This Been Tested?

provided unit tests

Key Areas to Review

Type of Change

New feature

Which Components or Systems Does This Change Impact?

Aptos Framework

Checklist

I have read and followed the CONTRIBUTING doc
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I identified and added all stakeholders and component owners affected by this change as reviewers
I tested both happy and unhappy path of the functionality
I have made corresponding changes to the documentation

trunk-io · 2024-10-04T18:01:30Z

⏱️ 4h 32m total CI duration on this PR

Slowest 15 Jobs	Cumulative Duration	Recent Runs
execution-performance / single-node-performance	1h 41m	⬜ 🟥 🟥 🟥 🟥
execution-performance / test-target-determinator	17m	🟩 🟩 🟩 🟩 🟩
rust-move-unit-coverage	16m	🟩
rust-move-unit-coverage	14m	🟩
test-target-determinator	14m	🟩 🟩 🟩 🟩
rust-move-unit-coverage	14m	🟩
rust-cargo-deny	14m	🟩 🟩 🟩 🟩 🟩 (+3 more)
rust-move-unit-coverage	11m	🟩
rust-move-unit-coverage	10m	🟩
rust-move-unit-coverage	9m	🟩
check-dynamic-deps	8m	🟩 🟩 🟩 🟩 🟩 (+4 more)
rust-move-tests	4m	🟥
semgrep/ci	4m	🟩 🟩 🟩 🟩 🟩 (+5 more)
rust-move-tests	4m	🟥
rust-move-tests	4m	🟥

🚨 2 jobs on the last run were significantly faster/slower than expected

Job	Duration	vs 7d avg	Delta
execution-performance / single-node-performance	37m	16m
test-target-determinator	3m	4m

_{settings ⋅ feedback ⋅ docs ⋅ learn more about trunk.io}

lightmark · 2024-10-04T18:10:59Z

aptos-move/framework/aptos-stdlib/sources/data_structures/ordered_map.move

+/// Uses cmp::compare for ordering, which compares primitive types natively, and uses common
+/// lexicographical sorting for complex types.
+module aptos_std::ordered_map {
+    // friend aptos_std::big_ordered_map;


will be uncommented in the PR with big_ordered_map

lightmark · 2024-10-04T18:11:38Z

aptos-move/framework/aptos-stdlib/sources/data_structures/ordered_map.move

+    /// The OrderedMap datastructure.
+    enum OrderedMap<K, V> has drop, copy, store {
+        /// sorted-vector based implementation of OrderedMap
+        SortedVectorMap {


codecov · 2024-10-04T18:12:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.4%. Comparing base (41a0b13) to head (76e0b76).

Additional details and impacted files

@@                 Coverage Diff                  @@
##           igor/native_compare   #14872   +/-   ##
====================================================
  Coverage                 57.4%    57.4%           
====================================================
  Files                      859      859           
  Lines                   211663   211663           
====================================================
  Hits                    121527   121527           
  Misses                   90136    90136

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

lightmark · 2024-10-04T18:30:53Z

aptos-move/framework/aptos-stdlib/sources/data_structures/ordered_map.move

+        let len = self.entries.length();
+        let index = binary_search(key, &self.entries, 0, len);
+        assert!(index < len, error::invalid_argument(EKEY_NOT_FOUND));
+        let Entry { key: old_key, value } = self.entries.remove(index);


vector does not keep the order here? IIRC, it swap and pop_back. Did you change that behavior?

remove keeps the order. swap_remove doesn't

lightmark · 2024-10-04T18:32:13Z

aptos-move/framework/aptos-stdlib/sources/data_structures/ordered_map.move

+    /// Aborts with EKEY_ALREADY_EXISTS if key already exist.
+    public fun add<K, V>(self: &mut OrderedMap<K, V>, key: K, value: V) {
+        let len = self.entries.length();
+        let index = binary_search(&key, &self.entries, 0, len);


we should introduce iterator to vector too so you don't need to know the length anymore for assertion.

this seems fine to me

lightmark · 2024-10-04T18:32:48Z

aptos-move/framework/aptos-stdlib/sources/data_structures/ordered_map.move

+    /// Changes the key, with keeping the same value attached to it
+    /// Aborts with EKEY_NOT_FOUND if `old_key` doesn't exist.
+    /// Aborts with ENEW_KEY_NOT_IN_ORDER if `new_key` doesn't keep the order `old_key` was in.
+    public(friend) fun replace_key_inplace<K: drop, V>(self: &mut OrderedMap<K, V>, old_key: &K, new_key: K) {


just curious, any use case for this

seems not generally useful, but in BTreeMap keys here represent max_key of a child subtree, and so I need to modify it in place.

lightmark · 2024-10-04T18:34:39Z

aptos-move/framework/aptos-stdlib/sources/data_structures/ordered_map.move

+            return;
+        };
+
+        // TODO: can be implemented more efficiently, as we know both maps are already sorted.


https://leetcode.com/problems/merge-two-sorted-lists/

yeah, but issue is here we have vectors, not lists, and so how to do it in-place, without moving too many elements.

Easiest is to can either create a new vector, populate, and then swap (I'll probably just do that)

if "vector" here had capacity, I could start from the end, without temporary storage, but I don't have a way to create empty values here (i.e. have this work without value being drop+copy)

lightmark · 2024-10-04T18:41:01Z

aptos-move/framework/aptos-stdlib/sources/data_structures/ordered_map.move

+            f(iter.iter_borrow_key(self), iter.iter_borrow(self));
+            iter = iter.iter_next(self);
+        }
+        // vector::for_each_ref(


what's wrong here?

entry is not a public type, so when this get's inlined in the caller, it cannot do compile.

basically inline functions need to be implemented only using public API.

I can remove this snippet as well

lightmark · 2024-10-04T18:42:04Z

aptos-move/framework/aptos-stdlib/sources/data_structures/ordered_map.move

+
+    // return index containing the key, or insert position.
+    // I.e. index of first element that has key larger or equal to the passed `key` argument.
+    fun binary_search<K, V>(key: &K, entries: &vector<Entry<K, V>>, start: u64, end: u64): u64 {


Can we make a standard Entry and implement binary search only once?

I am writing binary search only once.

If you mean for binary search to be reusable, so other's don't need to write it, maybe that should be an inline function in vector

Moving Entry to a standard separate file, makes all field accesses to require getter and setter functions, not sure that's best

lightmark

amazing work! Thanks @igor-aptos . You are the hero!

igor-aptos requested review from davidiw, lightmark, msmouse and wrwg October 4, 2024 18:01

igor-aptos requested a review from movekevin as a code owner October 4, 2024 18:01

igor-aptos requested a review from grao1991 October 4, 2024 18:01

lightmark reviewed Oct 4, 2024

View reviewed changes

lightmark approved these changes Oct 4, 2024

View reviewed changes

igor-aptos force-pushed the igor/native_compare branch from b508022 to 18ba714 Compare October 4, 2024 22:36

igor-aptos force-pushed the igor/ordered_map branch from 563d169 to d58cde2 Compare October 4, 2024 22:38

igor-aptos added CICD:run-execution-performance-test Run execution performance test CICD:run-execution-performance-full-test Run execution performance test (full version) labels Oct 4, 2024

igor-aptos force-pushed the igor/native_compare branch from 18ba714 to b0d9226 Compare October 8, 2024 19:00

igor-aptos requested review from zekun000, vgao1996 and georgemitenkov as code owners October 8, 2024 19:00

igor-aptos force-pushed the igor/ordered_map branch from d58cde2 to 70b3036 Compare October 8, 2024 19:02

igor-aptos force-pushed the igor/native_compare branch from b0d9226 to cef8611 Compare October 9, 2024 20:31

igor-aptos force-pushed the igor/ordered_map branch from 70b3036 to dc12951 Compare October 9, 2024 20:32

igor-aptos force-pushed the igor/native_compare branch from cef8611 to df51e9c Compare October 9, 2024 22:50

igor-aptos force-pushed the igor/ordered_map branch from dc12951 to c86d1c6 Compare October 9, 2024 22:50

igor-aptos force-pushed the igor/ordered_map branch from c86d1c6 to 3671695 Compare October 10, 2024 00:08

igor-aptos force-pushed the igor/native_compare branch from fcc2f52 to 4fd450c Compare October 10, 2024 18:10

igor-aptos force-pushed the igor/ordered_map branch from 3671695 to d849f67 Compare October 10, 2024 18:11

igor-aptos force-pushed the igor/native_compare branch from 4fd450c to 3f9d2fb Compare October 15, 2024 20:20

igor-aptos force-pushed the igor/ordered_map branch from d849f67 to db1b82e Compare October 15, 2024 20:20

igor-aptos force-pushed the igor/native_compare branch from 3f9d2fb to d5a9277 Compare October 16, 2024 21:10

igor-aptos force-pushed the igor/ordered_map branch from db1b82e to c9b6157 Compare October 16, 2024 21:11

igor-aptos force-pushed the igor/native_compare branch from d5a9277 to 41a0b13 Compare October 16, 2024 21:18

igor-aptos force-pushed the igor/ordered_map branch from c9b6157 to 76e0b76 Compare October 16, 2024 21:18

igor-aptos force-pushed the igor/native_compare branch from 41a0b13 to 36d7638 Compare October 21, 2024 23:27

igor-aptos force-pushed the igor/ordered_map branch from 76e0b76 to da9d4df Compare October 21, 2024 23:27

igor-aptos force-pushed the igor/native_compare branch from 36d7638 to e12056a Compare October 22, 2024 23:10

igor-aptos force-pushed the igor/ordered_map branch from da9d4df to e621db5 Compare October 22, 2024 23:11

igor-aptos force-pushed the igor/native_compare branch 2 times, most recently from 12807a4 to 1c15e62 Compare November 9, 2024 00:17

igor-aptos force-pushed the igor/ordered_map branch from e621db5 to 3fab948 Compare November 9, 2024 00:23

igor-aptos force-pushed the igor/native_compare branch from 1c15e62 to 37384ce Compare November 12, 2024 18:04

igor-aptos force-pushed the igor/ordered_map branch from 3fab948 to 33d382b Compare November 12, 2024 18:06

igor-aptos force-pushed the igor/native_compare branch 5 times, most recently from 3144f47 to 73c4d4d Compare November 13, 2024 21:13

Base automatically changed from igor/native_compare to main November 13, 2024 21:46

igor-aptos force-pushed the igor/ordered_map branch from 33d382b to 16b6fa3 Compare November 15, 2024 00:00

igor-aptos changed the base branch from main to igor/native_compare_move_part November 15, 2024 00:10

igor-aptos added 2 commits November 14, 2024 22:01

[move-stdlib] Introduce efficient OrderedMap implementation

4bbf461

Adding more tests, addressing some comments

209a588

igor-aptos force-pushed the igor/native_compare_move_part branch from 3c7a17d to 7c84b5f Compare November 15, 2024 20:59

igor-aptos force-pushed the igor/ordered_map branch from 16b6fa3 to 209a588 Compare November 15, 2024 20:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[move-stdlib] Introduce efficient OrderedMap implementation #14872

[move-stdlib] Introduce efficient OrderedMap implementation #14872

igor-aptos commented Oct 4, 2024

trunk-io bot commented Oct 4, 2024 •

edited

Loading

lightmark Oct 4, 2024

igor-aptos Oct 4, 2024

lightmark Oct 4, 2024

codecov bot commented Oct 4, 2024 •

edited

Loading

lightmark Oct 4, 2024 •

edited

Loading

igor-aptos Oct 9, 2024

lightmark Oct 4, 2024

igor-aptos Oct 9, 2024

lightmark Oct 4, 2024

igor-aptos Oct 9, 2024

lightmark Oct 4, 2024

igor-aptos Oct 9, 2024

lightmark Oct 4, 2024

igor-aptos Oct 9, 2024

lightmark Oct 4, 2024

igor-aptos Oct 9, 2024

lightmark left a comment

[move-stdlib] Introduce efficient OrderedMap implementation #14872

Are you sure you want to change the base?

[move-stdlib] Introduce efficient OrderedMap implementation #14872

Conversation

igor-aptos commented Oct 4, 2024

Description

How Has This Been Tested?

Key Areas to Review

Type of Change

Which Components or Systems Does This Change Impact?

Checklist

trunk-io bot commented Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Oct 4, 2024 • edited Loading

Codecov Report

lightmark Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lightmark left a comment

Choose a reason for hiding this comment

trunk-io bot commented Oct 4, 2024 •

edited

Loading

codecov bot commented Oct 4, 2024 •

edited

Loading

lightmark Oct 4, 2024 •

edited

Loading