Refactor: Flattens `TransactionContext::instruction_trace` #27109

Lichtso · 2022-08-12T16:31:20Z

Problem

ABIv2 will need a consecutive memory layout to map the instruction_trace into the VM address space. Also, putting everything in a single allocation would reduce the multi threading overhead of memory management dramatically.

Summary of Changes

The instruction_trace is flattened from a Vec<Vec<InstructionContext>> into a Vec<InstructionContext>. The outer Vec represented the transaction level instructions and the inner Vec the CPI instructions, the instruction_stack had the index into the outer Vec as the first entry and indices into the inner Vec for every following entry.

Now, both levels are collapsed into one homogeneous instruction_trace and instruction_stack. No information is lost by removing the partitioning of the outer Vec, because InstructionContext has a nesting_level property which can be used to partition by transaction level instructions while iterating.

Not just is the instruction_trace flattened, its interface is made structure independent as well. So, instead of returning a slice to the instruction_trace from which you then pick the instruction context or iterate over, we now provide a method to access a single entry by index_in_trace additionally to get_instruction_context_at_nesting_level.

Renames get_instruction_context_at() => get_instruction_context_at_nesting_level().
Replaces TransactionContext::get_instruction_trace() by TransactionContext::get_instruction_trace_length() and TransactionContext::get_instruction_context_at_index().
TransactionContext::instruction_accounts_lamport_sum() now takes an iterator instead of a slice.
Removes instruction_trace from ExecutionRecord.
Marks InstructionContext::new() as private.

jstarry

Changes look good to me, just some small comments and nits

jstarry · 2022-08-18T17:17:29Z

sdk/src/transaction_context.rs

-        let callee_instruction_accounts_lamport_sum =
-            self.instruction_accounts_lamport_sum(instruction_accounts)?;


Since this is fallible, it should be called first in the refactored code.

Good finding as well.

jstarry · 2022-08-18T18:46:29Z

programs/bpf_loader/src/syscalls/mod.rs

+        let mut reverse_index_at_stack_height = 0;
+        let mut instruction_context = None;
+        for index_in_trace in (0..instruction_trace_length).rev() {
+            let current_instruction_context = question_mark!(


nit: this variable doesn't always represent the current context, I think that next_instruction_context or just instruction_context (could rename instruction_context above to previous_instruction_context) would be less confusing.

sdk/src/transaction_context.rs

jstarry · 2022-08-18T19:01:59Z

sdk/src/transaction_context.rs

+    }
+
+    /// Gets an InstructionContext by its index in the trace
+    pub fn get_instruction_context_at_index(


nit: I find this method name to be difficult to understand. I wouldn't guess from its name that it's indexing into a flattened instruction trace. I think I prefer the way the previous code would get the trace and then index into the returned value.

See #27109 (comment) for why this interface changes in this fashion. Yes, the method might need a better name (proposals welcome).

Hmm maybe just change at_index to at_trace_index? Another thing that might be interesting is having a get_instruction_trace() method that returns at iterator over instruction contexts

jstarry · 2022-08-18T19:02:40Z

sdk/src/transaction_context.rs

@@ -48,8 +48,8 @@ pub struct TransactionContext {
    account_touched_flags: RefCell<Pin<Box<[bool]>>>,
    instruction_context_capacity: usize,
    instruction_stack: Vec<usize>,
-    number_of_instructions_at_transaction_level: usize,
-    instruction_trace: InstructionTrace,
+    _number_of_instructions_at_transaction_level: usize,


I assume this is left here due to ABI compatibility? Can you add a comment explaining that?

No, good finding. The field can be removed (for now).

jstarry · 2022-08-19T12:53:34Z

sdk/src/transaction_context.rs

+        program_accounts: Vec<usize>,
+        instruction_accounts: Vec<InstructionAccount>,
+        instruction_data: Vec<u8>,


Now that these are all Vec's, the to_vec() calls below are redundant

…ing_level.

Adds TransactionContext::get_instruction_trace_length() and TransactionContext::get_instruction_context_at_index().

… iterator instead of a slice.

…bs#27109) * Flattens TransactionContext::instruction_trace. * Stop the search at transaction level. * Renames get_instruction_context_at => get_instruction_context_at_nesting_level. * Removes TransactionContext::get_instruction_trace(). Adds TransactionContext::get_instruction_trace_length() and TransactionContext::get_instruction_context_at_index(). * Have TransactionContext::instruction_accounts_lamport_sum() accept an iterator instead of a slice. * Removes instruction_trace from ExecutionRecord. * make InstructionContext::new() private

* refactor: extract store_stake_accounts fn * refactor: extract store_vote_account fn * refactor: extract reward history update fn * remove avg point value from pay_valiator fn. not used * clippy: slice * clippy: slice * remove abort() from test-validator (#27124) * chore: bump bytes from 1.1.0 to 1.2.1 (#27172) * chore: bump bytes from 1.1.0 to 1.2.1 Bumps [bytes](https://github.com/tokio-rs/bytes) from 1.1.0 to 1.2.1. - [Release notes](https://github.com/tokio-rs/bytes/releases) - [Changelog](https://github.com/tokio-rs/bytes/blob/master/CHANGELOG.md) - [Commits](tokio-rs/bytes@v1.1.0...v1.2.1) --- updated-dependencies: - dependency-name: bytes dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * [auto-commit] Update all Cargo lock files Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot-buildkite <[email protected]> * Share Ancestors API get with contains_key (#27161) consolidate similar fns * Rename to `MAX_BLOCK_ACCOUNTS_DATA_SIZE_DELTA` (#27175) * chore: bump libc from 0.2.129 to 0.2.131 (#27162) * chore: bump libc from 0.2.129 to 0.2.131 Bumps [libc](https://github.com/rust-lang/libc) from 0.2.129 to 0.2.131. - [Release notes](https://github.com/rust-lang/libc/releases) - [Commits](rust-lang/libc@0.2.129...0.2.131) --- updated-dependencies: - dependency-name: libc dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> * [auto-commit] Update all Cargo lock files Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot-buildkite <[email protected]> * reverts wide fanout in broadcast when the root node is down (#26359) A change included in #20480 was that when the root node in turbine broadcast tree is down, the leader will broadcast the shred to all nodes in the first layer. The intention was to mitigate the impact of dead nodes on shreds propagation, because if the root node is down, then the entire cluster will miss out the shred. On the other hand, if x% of stake is down, this will cause 200*x% + 1 packets/shreds ratio at the broadcast stage which might contribute to line-rate saturation and packet drop. To avoid this bandwidth saturation issue, this commit reverts that logic and always broadcasts shreds from the leader only to the root node. As before we rely on erasure codes to recover shreds lost due to staked nodes being offline. * add getTokenLargestAccounts rpc method to rust client (#26840) * add get token largest accounts rpc call to client * split to include with commitment * Bump spl-token-2022 (#27181) * Bump token-2022 to 0.4.3 * Allow cargo to bump stuff to v1.11.5 * VoteProgram.safeWithdraw function to safeguard against accidental vote account closures (#26586) feat: safe withdraw function Co-authored-by: aschonfeld <[email protected]> * chore: bump futures from 0.3.21 to 0.3.23 (#27182) * chore: bump futures from 0.3.21 to 0.3.23 Bumps [futures](https://github.com/rust-lang/futures-rs) from 0.3.21 to 0.3.23. - [Release notes](https://github.com/rust-lang/futures-rs/releases) - [Changelog](https://github.com/rust-lang/futures-rs/blob/master/CHANGELOG.md) - [Commits](rust-lang/futures-rs@0.3.21...0.3.23) --- updated-dependencies: - dependency-name: futures dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> * [auto-commit] Update all Cargo lock files Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot-buildkite <[email protected]> * chore: bump nix from 0.24.2 to 0.25.0 (#27179) * chore: bump nix from 0.24.2 to 0.25.0 Bumps [nix](https://github.com/nix-rust/nix) from 0.24.2 to 0.25.0. - [Release notes](https://github.com/nix-rust/nix/releases) - [Changelog](https://github.com/nix-rust/nix/blob/master/CHANGELOG.md) - [Commits](nix-rust/nix@v0.24.2...v0.25.0) --- updated-dependencies: - dependency-name: nix dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * [auto-commit] Update all Cargo lock files Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot-buildkite <[email protected]> * Parse ConfidentialTransaction instructions (#26825) Parse ConfidentialTransfer instructions * snapshots: serialize version file first (#27192) serialize version file first * serialize incremental_snapshot_hash (#26839) * serialize incremental_snapshot_hash * pr feedback * derives Error trait for ClusterInfoError and core::result::Error (#27208) * Add clean_accounts_for_tests() (#27200) * Rust v1.63.0 (#27148) * Upgrade to Rust v1.63.0 * Add nightly_clippy_allows * Resolve some new clippy nightly lints * Increase QUIC packets completion timeout Co-authored-by: Michael Vines <[email protected]> * docs: updated "transaction fees" page (#26861) * docs: transaction fees, compute units, compute budget * docs: added messages definition * Revert "docs: added messages definition" This reverts commit 3c56156. * docs: added messages definition * Update docs/src/transaction_fees.md Co-authored-by: Jacob Creech <[email protected]> * fix: updates from feedback Co-authored-by: Jacob Creech <[email protected]> * sdk: Fix args after "--" in build-bpf and test-bpf (#27221) * Flaky Unit Test test_rpc_subscriptions (#27214) Increase unit test timeout from 5 seconds to 10 seconds * chore: only buildkite pipelines use sccache in docker-run.sh (#27204) chore: only buildkite ci use sccache * clean feature: `prevent_calling_precompiles_as_programs` (#27100) * clean feature: prevent_calling_precompiles_as_programs * fix tests * fix test * remove comment * fix test * feedback * Add get_account_with_commitment to BenchTpsClient (#27176) * Fix a corner-case panic in get_entries_in_data_block() (#27195) #### Problem get_entries_in_data_block() panics when there's inconsistency between slot_meta and data_shred. However, as we don't lock on reads, reading across multiple column families is not atomic (especially for older slots) and thus does not guarantee consistency as the background cleanup service could purge the slot in the middle. Such panic was reported in #26980 when the validator serves a high load of RPC calls. #### Summary of Changes This PR makes get_entries_in_data_block() panic only when the inconsistency between slot-meta and data-shred happens on a slot older than lowest_cleanup_slot. * Verify snapshot slot deltas (#26666) * store-tool: log lamports for each account (#27168) log lamports for each account * add an assert for a debug feature to avoid wasted time (#27210) * remove redundant call that bumps age to future (#27215) * Use from_secs api to create duration (#27222) use from_secs api to create duration * reorder slot # in debug hash data path (#27217) * create helper fn for clarity (#27216) * Verifying snapshot bank must always specify the snapshot slot (#27234) * Remove `Bank::ensure_no_storage_rewards_pool()` (#26468) * cli: Add subcommands for address lookup tables (#27123) * cli: Add subcommand for creating address lookup tables * cli: Add additional subcommands for address lookup tables * short commands * adds hash domain to ping-pong protocol (#27193) In order to maintain backward compatibility, for now the responding node will hash the token both with and without domain so that the other node will accept the response regardless of its upgrade status. Once the cluster has upgraded to the new code, we will remove the legacy domain = false case. * Revert "Rust v1.63.0 (#27148)" (#27245) This reverts commit a2e7bdf. * correct double negation (#27240) * Enable QUIC client by default. Add arg to disable QUIC client. (Forward port #26927) (#27194) Enable QUIC client by default. Add arg to disable QUIC client. * Enable QUIC client by default. Add arg to disable QUIC client. * Deprecate --disable-quic-servers arg * Add #[ignore] annotation to failing tests * slots_connected: check if the range is connected (>= ending_slot) (#27152) * create-snapshot check if snapshot slot exists (#27153) * Add Bank::clean_accounts_for_tests() (#27209) * Call `AccountsDb::shrink_all_slots()` directly (#27235) * add ed25519_program to built-in instruction cost list (#27199) * add ed25519_program to built-in instruction cost list * Remove unnecessary and stale comment * simple refactorings to disk idx (#27238) * add _inclusive for clarity (#27239) * eliminate unnecessary ZERO_RAW_LAMPORTS_SENTINEL (#27218) * make test code more clear (#27260) * banking stage: actually aggregate tracer packet stats (#27118) * aggregated_tracer_packet_stats_option was alwasys None * Actually accumulate tracer packet stats * Refactor epoch reward 1 (#27253) * refactor: extract store_stake_accounts fn * clippy: slice Co-authored-by: haoran <haoran@mbook> * recovers merkle shreds from erasure codes (#27136) The commit * Identifies Merkle shreds when recovering from erasure codes and dispatches specialized code to reconstruct shreds. * Coding shred headers are added to recovered erasure shards. * Merkle tree is reconstructed for the erasure batch and added to recovered shreds. * The common signature (for the root of Merkle tree) is attached to all recovered shreds. * Simplify `Bank::clean_accounts()` by removing params (#27254) * Account files remove (#26910) * Create a new function cleanup_accounts_paths, a trivial change * Remove account files asynchronously * Update and simplify the implementation after the validator test runs. * Fixes after testing on the dev device * Discard tokio. Use thread instead * Fix comments format * Fix config type to pass the github test * Fix failed tests. Handle the case of non-existing path * Final cleanup, addressing the review comments Avoided OsString. Made the function more generic with "impl AsRef<Path>" Co-authored-by: Jeff Washington <[email protected]> * Refactor: Flattens `TransactionContext::instruction_trace` (#27109) * Flattens TransactionContext::instruction_trace. * Stop the search at transaction level. * Renames get_instruction_context_at => get_instruction_context_at_nesting_level. * Removes TransactionContext::get_instruction_trace(). Adds TransactionContext::get_instruction_trace_length() and TransactionContext::get_instruction_context_at_index(). * Have TransactionContext::instruction_accounts_lamport_sum() accept an iterator instead of a slice. * Removes instruction_trace from ExecutionRecord. * make InstructionContext::new() private * Parallel insertion of dirty store keys during clean (#27058) parallelize dirty store key insertion * Refactor epoch reward 2 (#27257) * refactor: extract store_stake_accounts fn * refactor: extract store_vote_account fn * clippy: slice * clippy: slice * fix merge error Co-authored-by: haoran <haoran@mbook> * Standardize thread names Tenets: 1. Limit thread names to 15 characters 2. Prefix all Solana-controlled threads with "sol" 3. Use Camel case. It's more character dense than Snake or Kebab case * cleanup comment on filter_zero_lamport_clean_for_incremental_snapshots (#27273) * remove inaccurate log (#27255) * patches metrics for invalid cached vote/stake accounts (#27266) patches invalid cached vote/stake accounts metrics Invalid cached vote accounts is overcounting actual mismatches, and invalid cached stake accounts is undercounting. * Refactor epoch reward 3 (#27259) * refactor: extract store_stake_accounts fn * refactor: extract store_vote_account fn * refactor: extract reward history update fn * clippy: slice * clippy: slice Co-authored-by: haoran <haoran@mbook> * fix merges Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: haoran <haoran@mbook> Co-authored-by: Jeff Biseda <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot-buildkite <[email protected]> Co-authored-by: Brooks Prumo <[email protected]> Co-authored-by: behzad nouri <[email protected]> Co-authored-by: AJ Taylor <[email protected]> Co-authored-by: Tyera Eulberg <[email protected]> Co-authored-by: Andrew Schonfeld <[email protected]> Co-authored-by: aschonfeld <[email protected]> Co-authored-by: apfitzge <[email protected]> Co-authored-by: Jeff Washington (jwash) <[email protected]> Co-authored-by: Brennan Watt <[email protected]> Co-authored-by: Michael Vines <[email protected]> Co-authored-by: Nick Frostbutter <[email protected]> Co-authored-by: Jacob Creech <[email protected]> Co-authored-by: Jon Cinque <[email protected]> Co-authored-by: Yihau Chen <[email protected]> Co-authored-by: Justin Starry <[email protected]> Co-authored-by: kirill lykov <[email protected]> Co-authored-by: Yueh-Hsuan Chiang <[email protected]> Co-authored-by: leonardkulms <[email protected]> Co-authored-by: Will Hickey <[email protected]> Co-authored-by: Tao Zhu <[email protected]> Co-authored-by: Xiang Zhu <[email protected]> Co-authored-by: Jeff Washington <[email protected]> Co-authored-by: Alexander Meißner <[email protected]>

Lichtso force-pushed the refactor/flatten_transaction_context_instruction_trace branch from 8ec7137 to 7d765f3 Compare August 12, 2022 17:35

Lichtso requested review from jackcmay and jstarry August 13, 2022 09:09

Lichtso force-pushed the refactor/flatten_transaction_context_instruction_trace branch 2 times, most recently from 5fcf423 to ad79ff0 Compare August 16, 2022 11:12

jstarry reviewed Aug 18, 2022

View reviewed changes

Lichtso force-pushed the refactor/flatten_transaction_context_instruction_trace branch 6 times, most recently from 7a1ef08 to 9f95620 Compare August 19, 2022 10:07

jstarry reviewed Aug 19, 2022

View reviewed changes

Lichtso force-pushed the refactor/flatten_transaction_context_instruction_trace branch from 9f95620 to 6bb2410 Compare August 19, 2022 15:03

Lichtso added 7 commits August 19, 2022 23:52

Flattens TransactionContext::instruction_trace.

ac73b16

Stop the search at transaction level.

185030a

Renames get_instruction_context_at => get_instruction_context_at_nest…

0d1beb4

…ing_level.

Removes TransactionContext::get_instruction_trace().

7c9436a

Adds TransactionContext::get_instruction_trace_length() and TransactionContext::get_instruction_context_at_index().

Have TransactionContext::instruction_accounts_lamport_sum() accept an…

8d612b9

… iterator instead of a slice.

Removes instruction_trace from ExecutionRecord.

76f4843

make InstructionContext::new() private

f51dab8

Lichtso force-pushed the refactor/flatten_transaction_context_instruction_trace branch from 6bb2410 to f51dab8 Compare August 19, 2022 21:52

Lichtso merged commit 55d18e8 into solana-labs:master Aug 20, 2022

Lichtso deleted the refactor/flatten_transaction_context_instruction_trace branch August 20, 2022 09:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor: Flattens `TransactionContext::instruction_trace` #27109

Refactor: Flattens `TransactionContext::instruction_trace` #27109

Lichtso commented Aug 12, 2022 •

edited

Loading

jstarry left a comment

jstarry Aug 18, 2022

Lichtso Aug 18, 2022

jstarry Aug 18, 2022

jstarry Aug 18, 2022

Lichtso Aug 18, 2022

jstarry Aug 19, 2022

jstarry Aug 18, 2022

Lichtso Aug 18, 2022

jstarry Aug 19, 2022

		let callee_instruction_accounts_lamport_sum =
		self.instruction_accounts_lamport_sum(instruction_accounts)?;

Refactor: Flattens TransactionContext::instruction_trace #27109

Refactor: Flattens TransactionContext::instruction_trace #27109

Conversation

Lichtso commented Aug 12, 2022 • edited Loading

Problem

Summary of Changes

jstarry left a 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

Refactor: Flattens `TransactionContext::instruction_trace` #27109

Refactor: Flattens `TransactionContext::instruction_trace` #27109

Lichtso commented Aug 12, 2022 •

edited

Loading