Remove frozen ABI modules from solana-sdk #13008

mvines · 2020-10-20T06:37:02Z

With the creation of solana-program-sdk (#12989), the frozen ABI support can no longer live in solana-sdk as that would cause a circular dependency. Create a stand-alone /frozen-abi (and /frozen-abi-macro) crate for this facility

mvines · 2020-10-20T07:15:16Z

frozen-abi/src/abi_example.rs

@@ -213,9 +213,7 @@ atomic_example_impls! { AtomicI64 }
 atomic_example_impls! { AtomicIsize }
 atomic_example_impls! { AtomicBool }

-#[cfg(feature = "everything")]


Feature removal!

mvines · 2020-10-20T07:16:16Z

frozen-abi/src/abi_digester.rs

@@ -550,7 +550,7 @@ mod tests {
        test_field2: i8,
    }

-    #[frozen_abi(digest = "Hv597t4PieHYvgiXnwRSpKBRTWqteUS4nHZHY6ZxX69v")]
+    #[frozen_abi(digest = "GMeECsxg37a5qznstWXeeX3d6HXs6j12oB4SKaZZuNJk")]


@ryoqun - These two hashes changed on me for some reason. Seems harmless though. Maybe it's due to the crate rename somenow?

yeah, it detects such renames because it need to consider XX::Hash to be different from YY::Hash.

$ diff -U3 /tmp/abi8/*Hv597t4PieHYvgiXnwRSpKBRTWqteUS4nHZHY6ZxX69v* /tmp/abi8/*GMeECsxg37a5qznstWXeeX3d6HXs6j12oB4SKaZZuNJk* --- /tmp/abi8/abi_digester__tests__TestNest_frozen_abi__test_abi_digest_Hv597t4PieHYvgiXnwRSpKBRTWqteUS4nHZHY6ZxX69v 2020-10-20 21:17:01.936993559 +0900 +++ /tmp/abi8/abi_digester__tests__TestNest_frozen_abi__test_abi_digest_GMeECsxg37a5qznstWXeeX3d6HXs6j12oB4SKaZZuNJk 2020-10-20 21:21:09.115486766 +0900 @@ -1,31 +1,31 @@ struct TestNest (fields = 1) - field nested_field: [solana_sdk::abi_digester::tests::TestStruct; 5] + field nested_field: [solana_frozen_abi::abi_digester::tests::TestStruct; 5] tuple (elements = 5) - element solana_sdk::abi_digester::tests::TestStruct + element solana_frozen_abi::abi_digester::tests::TestStruct struct TestStruct (fields = 2) field test_field: i8 primitive i8 field test_field2: i8 primitive i8 - element solana_sdk::abi_digester::tests::TestStruct + element solana_frozen_abi::abi_digester::tests::TestStruct struct TestStruct (fields = 2) field test_field: i8 primitive i8 field test_field2: i8 primitive i8 - element solana_sdk::abi_digester::tests::TestStruct + element solana_frozen_abi::abi_digester::tests::TestStruct struct TestStruct (fields = 2) field test_field: i8 primitive i8 field test_field2: i8 primitive i8 - element solana_sdk::abi_digester::tests::TestStruct + element solana_frozen_abi::abi_digester::tests::TestStruct struct TestStruct (fields = 2) field test_field: i8 primitive i8 field test_field2: i8 primitive i8 - element solana_sdk::abi_digester::tests::TestStruct + element solana_frozen_abi::abi_digester::tests::TestStruct struct TestStruct (fields = 2) field test_field: i8 primitive i8

$ sha256sum /tmp/abi8/abi_digester__tests__TestNest_frozen_abi__test_abi_digest_Hv597t4PieHYvgiXnwRSpKBRTWqteUS4nHZHY6ZxX69v | xxd -r -p - | base58 && echo Hv597t4PieHYvgiXnwRSpKBRTWqteUS4nHZHY6ZxX69v $ sha256sum /tmp/abi8/abi_digester__tests__TestNest_frozen_abi__test_abi_digest_GMeECsxg37a5qznstWXeeX3d6HXs6j12oB4SKaZZuNJk | xxd -r -p - | base58 && echo GMeECsxg37a5qznstWXeeX3d6HXs6j12oB4SKaZZuNJk

mvines · 2020-10-20T07:17:13Z

runtime/src/serde_snapshot/tests.rs

@@ -262,7 +262,7 @@ mod test_bank_serialize {

    // These some what long test harness is required to freeze the ABI of
    // Bank's serialization due to versioned nature
-    #[frozen_abi(digest = "5rd8RyVSLH3hm12xJDVCJWgc1gyqb4Ukt2hJLJNfsB5v")]
+    #[frozen_abi(digest = "ULV2jDndxR3JB677ayyjaamtAcZ24q75tCkHS2bKVoy")]


This hash changed too. Again seems harmless but 🤔

yeah, because of fully qualified symbol name change of frozen abi:

$ diff -U3 /tmp/abi8/*5rd8RyVSLH3hm12xJDVCJWgc1gyqb4Ukt2hJLJNfsB5v* /tmp/abi8/*ULV2jDndxR3JB677ayyjaamtAcZ24q75tCkHS2bKVoy* --- /tmp/abi8/serde_snapshot__tests__test_bank_serialize__BankAbiTestWrapperFuture_frozen_abi__test_abi_digest_5rd8RyVSLH3hm12xJDVCJWgc1gyqb4Ukt2hJLJNfsB5v 2020-10-20 21:17:01.836997400 +0900 +++ /tmp/abi8/serde_snapshot__tests__test_bank_serialize__BankAbiTestWrapperFuture_frozen_abi__test_abi_digest_ULV2jDndxR3JB677ayyjaamtAcZ24q75tCkHS2bKVoy 2020-10-20 21:21:11.131409159 +0900 @@ -1617,11 +1617,11 @@ struct MessageProcessor (fields = 0) element solana_runtime::serde_snapshot::SerializableAccountsDB<solana_runtime::serde_snapshot::future::Context> tuple (elements = 4) - element solana_runtime::serde_snapshot::utils::serialize_iter_as_map::SerializableMappedIterator<core::iter::adapters::Map<core::slice::Iter<alloc::vec::Vec<alloc::sync::Arc<solana_runtime::accounts_db::AccountStorageEntry>>>, <solana_runtime::serde_snapshot::future::Context as solana_runtime::serde_snapshot::TypeContext>::serialize_accounts_db_fields<solana_sdk::abi_digester::AbiDigester>::{{closure}}>> + element solana_runtime::serde_snapshot::utils::serialize_iter_as_map::SerializableMappedIterator<core::iter::adapters::Map<core::slice::Iter<alloc::vec::Vec<alloc::sync::Arc<solana_runtime::accounts_db::AccountStorageEntry>>>, <solana_runtime::serde_snapshot::future::Context as solana_runtime::serde_snapshot::TypeContext>::serialize_accounts_db_fields<solana_frozen_abi::abi_digester::AbiDigester>::{{closure}}>> map (entries = 1) key u64 primitive u64 - value solana_runtime::serde_snapshot::utils::serialize_iter_as_seq::SerializableSequencedIterator<core::iter::adapters::Map<core::slice::Iter<alloc::sync::Arc<solana_runtime::accounts_db::AccountStorageEntry>>, <solana_runtime::serde_snapshot::future::Context as solana_runtime::serde_snapshot::TypeContext>::serialize_accounts_db_fields<solana_sdk::abi_digester::AbiDigester>::{{closure}}::{{closure}}>> + value solana_runtime::serde_snapshot::utils::serialize_iter_as_seq::SerializableSequencedIterator<core::iter::adapters::Map<core::slice::Iter<alloc::sync::Arc<solana_runtime::accounts_db::AccountStorageEntry>>, <solana_runtime::serde_snapshot::future::Context as solana_runtime::serde_snapshot::TypeContext>::serialize_accounts_db_fields<solana_frozen_abi::abi_digester::AbiDigester>::{{closure}}::{{closure}}>> seq (elements = 1) element solana_runtime::serde_snapshot::future::SerializableAccountStorageEntry struct SerializableAccountStorageEntry (fields = 2)

Perfect, thanks for confirming!

ryoqun · 2020-10-20T12:26:37Z

frozen-abi/src/abi_digester.rs

@@ -573,7 +573,7 @@ mod tests {
        VARIANT2(u8, u16),
    }

-    #[frozen_abi(digest = "CKxzv7VjyUrNR9fGJpTpKyMBWJM4gepKshCS8oV14T1Q")]
+    #[frozen_abi(digest = "DywMfwKq8HZCbUfTwnemHWMN8LvMZCvipQuLddQ2ywwG")]


here it is:

$ diff -U3 /tmp/abi8/*CKxzv7VjyUrNR9fGJpTpKyMBWJM4gepKshCS8oV14T1Q* /tmp/abi8/*DywMfwKq8HZCbUfTwnemHWMN8LvMZCvipQuLddQ2ywwG* --- /tmp/abi8/abi_digester__tests__TestVecEnum_frozen_abi__test_abi_digest_CKxzv7VjyUrNR9fGJpTpKyMBWJM4gepKshCS8oV14T1Q 2020-10-20 21:17:02.036989718 +0900 +++ /tmp/abi8/abi_digester__tests__TestVecEnum_frozen_abi__test_abi_digest_DywMfwKq8HZCbUfTwnemHWMN8LvMZCvipQuLddQ2ywwG 2020-10-20 21:21:09.171484610 +0900 @@ -1,7 +1,7 @@ struct TestVecEnum (fields = 1) - field enums: alloc::vec::Vec<solana_sdk::abi_digester::tests::TestTupleVariant> + field enums: alloc::vec::Vec<solana_frozen_abi::abi_digester::tests::TestTupleVariant> seq (elements = 1) - element solana_sdk::abi_digester::tests::TestTupleVariant + element solana_frozen_abi::abi_digester::tests::TestTupleVariant enum TestTupleVariant (variants = 2) variant(0) VARIANT1 (fields = 2) field u8

$ sha256sum /tmp/abi8/abi_digester__tests__TestVecEnum_frozen_abi__test_abi_digest_CKxzv7VjyUrNR9fGJpTpKyMBWJM4gepKshCS8oV14T1Q | xxd -r -p - | base58 && echo CKxzv7VjyUrNR9fGJpTpKyMBWJM4gepKshCS8oV14T1Q $ sha256sum /tmp/abi8/abi_digester__tests__TestVecEnum_frozen_abi__test_abi_digest_DywMfwKq8HZCbUfTwnemHWMN8LvMZCvipQuLddQ2ywwG | xxd -r -p - | base58 && echo DywMfwKq8HZCbUfTwnemHWMN8LvMZCvipQuLddQ2ywwG

ryoqun · 2020-10-20T12:33:51Z

thanks for caring the frozen abi thing. :)

codecov · 2020-10-20T21:16:48Z

Codecov Report

Merging #13008 into master will increase coverage by 0.0%.
The diff coverage is 70.8%.

@@           Coverage Diff           @@
##           master   #13008   +/-   ##
=======================================
  Coverage    82.0%    82.0%           
=======================================
  Files         362      364    +2     
  Lines       85383    85390    +7     
=======================================
+ Hits        70052    70070   +18     
+ Misses      15331    15320   -11

ryoqun · 2020-10-21T00:16:26Z

test-abi.sh

+
+here=$(dirname "$0")
+set -x
+exec ${here}/cargo nightly test --lib -- test_abi_


I wonder why this slipped through the shellcheck on this pr's ci build... #13039

well, shellcheck wasn't run at all. maybe there is a bug when dynamic buildpipeline.... I'll look at this later.

https://buildkite.com/solana-labs/solana/builds/33226

* Remove frozen ABI modules from solana-sdk (cherry picked from commit 6858950) # Conflicts: # Cargo.lock # core/Cargo.toml # frozen-abi/macro/Cargo.toml # programs/bpf/Cargo.lock # programs/stake/Cargo.toml # programs/vote/Cargo.toml # runtime/Cargo.toml # sdk/Cargo.toml # version/Cargo.toml * rebase * fix broken ci (#13039) Co-authored-by: Michael Vines <[email protected]> Co-authored-by: Ryo Onodera <[email protected]>

mvines added the v1.4 label Oct 20, 2020

mvines force-pushed the abi branch 7 times, most recently from 2d5d276 to e1d2bfb Compare October 20, 2020 07:07

mvines commented Oct 20, 2020

View reviewed changes

ryoqun reviewed Oct 20, 2020

View reviewed changes

mvines force-pushed the abi branch 4 times, most recently from 0a8d566 to eb87ab3 Compare October 20, 2020 18:05

Remove frozen ABI modules from solana-sdk

0cef6e2

mvines force-pushed the abi branch from eb87ab3 to 0cef6e2 Compare October 20, 2020 19:32

mvines merged commit 6858950 into solana-labs:master Oct 20, 2020

mergify bot mentioned this pull request Oct 20, 2020

Remove frozen ABI modules from solana-sdk (bp #13008) #13036

Merged

ryoqun reviewed Oct 21, 2020

View reviewed changes

ryoqun mentioned this pull request May 26, 2023

Explain use of nightly clippy over whole monorepo #31833

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove frozen ABI modules from solana-sdk #13008

Remove frozen ABI modules from solana-sdk #13008

mvines commented Oct 20, 2020

mvines Oct 20, 2020

mvines Oct 20, 2020

ryoqun Oct 20, 2020

mvines Oct 20, 2020

ryoqun Oct 20, 2020

mvines Oct 20, 2020

ryoqun Oct 20, 2020

ryoqun Oct 20, 2020

ryoqun commented Oct 20, 2020

codecov bot commented Oct 20, 2020

ryoqun Oct 21, 2020

ryoqun Oct 21, 2020

ryoqun Oct 21, 2020

Remove frozen ABI modules from solana-sdk #13008

Remove frozen ABI modules from solana-sdk #13008

Conversation

mvines commented Oct 20, 2020

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

ryoqun commented Oct 20, 2020

codecov bot commented Oct 20, 2020

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment