refactor: use requires to assert and automatically log richer information on failure #65
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,240 @@ | ||
| /// | ||
| /// require true | ||
| /// | ||
| #[macro_export] | ||
| macro_rules! require { | ||
| ($cond:expr, $error:expr) => {{ | ||
| if !$cond { | ||
|
Contributor
There was a problem hiding this comment. they can all use
Contributor
Author
There was a problem hiding this comment. Yes. I could use that. But
Contributor
Author
There was a problem hiding this comment. I'm not addressing this in this PR. Will consider doing it in the coming PRs. We'll probably move requires.rs to some common library crate.
Contributor
There was a problem hiding this comment. Sure, can be done in another PRs, it just felt appropriate since introducing all the requires. FYI, here's the benchmark by just adding unlikely. It probably indicates that either the compiler does some weird stuff, or we are doing too many checks on some paths. ───────────────────────────────────────────────────────────────────────────────
Key Baseline CU Current CU Δ CU Δ %
───────────────────────────────────────────────────────────────────────────────
close_eata::close 1,726 1,723 -3 -0.17%
create_eata_perm::default 13,709 13,569 -140 -1.02%
create_eata_perm::permissionless 24,198 24,058 -140 -0.58%
del_eata::delegate 43,435 43,337 -98 -0.23%
del_eata::non_owner 29,935 29,837 -98 -0.33%
del_eata::redelegate 152 152 +0 +0.00%
del_eata::reinit 7,713 7,716 +3 +0.04%
del_eata_perm::delegate 48,487 48,485 -2 -0.00%
del_eata_perm::non_owner 52,987 52,985 -2 -0.00%
del_eata_perm::redelegate 175 174 -1 -0.57%
del_shuttle_eata::delegate 25,546 25,434 -112 -0.44%
del_shuttle_eata::redelegate 173 160 -13 -7.51%
del_shuttle_merge::delegate 80,548 79,861 -687 -0.85%
del_shuttle_priv::queue 27,991 27,890 -101 -0.36%
del_shuttle_priv::shuttle 128,773 128,086 -687 -0.53%
del_tq::delegate 23,491 23,390 -101 -0.43%
del_tq::redelegate 1,793 1,794 +1 +0.06%
dep_queue::accepts_legacy_destination_ata 13,509 13,503 -6 -0.04%
dep_queue::all_splits_use_client_ref_id 10,980 10,976 -4 -0.04%
dep_queue::assign_group_id_0 10,712 10,706 -6 -0.06%
dep_queue::assign_group_id_1 11,180 11,174 -6 -0.05%
dep_queue::deterministic_delays 11,383 11,377 -6 -0.05%
dep_queue::once_split 10,953 10,947 -6 -0.05%
dep_queue::reject_delay_range 576 574 -2 -0.35%
dep_queue::reject_queue_full 289 282 -7 -2.42%
dep_queue::reject_split_gt_amt 573 572 -1 -0.17%
dep_queue::reject_zero_split 571 569 -2 -0.35%
dep_queue::return_to_shuttle 7,851 7,844 -7 -0.09%
dep_queue::split3_mod5 11,152 11,146 -6 -0.05%
dep_queue::split4_mod5 11,504 11,498 -6 -0.05%
dep_shuttle::deposit 7,861 7,858 -3 -0.04%
dep_spl::deposit 7,861 7,858 -3 -0.04%
init_eata::init 4,723 4,588 -135 -2.86%
init_gvault::init 15,931 15,795 -136 -0.85%
init_gvault::migrate 12,998 12,863 -135 -1.04%
init_shuttle::init 19,009 18,733 -276 -1.45%
init_tq::custom 14,997 14,991 -6 -0.04%
init_tq::default 13,530 13,524 -6 -0.04%
init_tq::noop 6,424 6,420 -4 -0.06%
lamports_pda::allow_extra_lamports 1,876 1,834 -42 -2.24%
lamports_pda::sponsored_lamports_transfer 61,282 60,894 -388 -0.63%
lamports_pda::transfer_lamports_pda 6,376 6,334 -42 -0.66%
merge_shuttle::merge 9,489 9,456 -33 -0.35%
rent_pda::init 1,631 1,632 +1 +0.06%
rent_pda::reinit 240 241 +1 +0.42%
reset_eata_perm::reset 26,531 26,389 -142 -0.54%
tq_alloc::already_allocated 1,837 1,837 +0 +0.00%
tq_alloc::first_allocate 19,030 19,030 +0 +0.00%
tq_auto::crank_1 5,331 5,332 +1 +0.02%
tq_auto::crank_2 6,497 6,498 +1 +0.02%
tq_auto::crank_bad_magic 807 807 +0 +0.00%
tq_auto::enqueue_delayed 10,437 10,431 -6 -0.06%
tq_auto::enqueue_ready 10,437 10,431 -6 -0.06%
tq_auto::enqueue_with_client_ref_id 10,438 10,434 -4 -0.04%
tq_auto::run_scheduled_tick 15,323 15,319 -4 -0.03%
tq_auto::run_scheduled_tick_via_magic_bundle 15,321 15,317 -4 -0.03%
tq_auto::schedule 5,331 5,332 +1 +0.02%
tq_auto::schedule_with_client_ref_id 5,331 5,332 +1 +0.02%
tq_auto::tick_after_bundle 2,112 2,106 -6 -0.28%
tq_auto::tick_empty 2,112 2,106 -6 -0.28%
tq_auto::tick_not_ready 2,198 2,192 -6 -0.27%
ud_wd_close::undelegate 13,765 13,743 -22 -0.16%
undel_eata_cb::undelegate 36,856 36,856 +0 +0.00%
undel_perm_cb::undelegate 34,444 34,444 +0 +0.00%
wd_shuttle::withdraw 64,188 63,703 -485 -0.76%
wd_spl::withdraw 7,885 7,874 -11 -0.14%
─────────────────────────────────────────────────────────────────────────────── |
||
| let expr = stringify!($cond); | ||
| pinocchio_log::log!("require!({}) failed.", expr); | ||
| return Err($error.into()); | ||
| } | ||
| }}; | ||
| } | ||
|
|
||
| /// | ||
| /// require key1 == key2 | ||
| /// | ||
| #[macro_export] | ||
| macro_rules! require_eq_keys { | ||
| ( $key1:expr, $key2:expr, $error:expr) => {{ | ||
| if !pinocchio::address::address_eq($key1, $key2) { | ||
| pinocchio_log::log!( | ||
| "require_eq_keys!({}, {}) failed: ", | ||
| stringify!($key1), | ||
| stringify!($key2) | ||
| ); | ||
| $key1.log(); | ||
| $key2.log(); | ||
| return Err($error.into()); | ||
| } | ||
| }}; | ||
| } | ||
|
|
||
| /// | ||
| /// require key1 != key2 | ||
| /// | ||
| #[macro_export] | ||
| macro_rules! require_ne_keys { | ||
| ( $key1:expr, $key2:expr, $error:expr) => {{ | ||
| if pinocchio::address::address_eq($key1, $key2) { | ||
| pinocchio_log::log!( | ||
| "require_ne_keys!({}, {}) failed: ", | ||
| stringify!($key1), | ||
| stringify!($key2) | ||
| ); | ||
| $key1.log(); | ||
| $key2.log(); | ||
| return Err($error.into()); | ||
| } | ||
| }}; | ||
| } | ||
|
|
||
| /// | ||
| /// require a <= b | ||
| /// | ||
| #[macro_export] | ||
| macro_rules! require_le { | ||
| ( $val1:expr, $val2:expr, $error:expr) => {{ | ||
| if !($val1 <= $val2) { | ||
| pinocchio_log::log!( | ||
| "require_le!({}, {}) failed: {} <= {}", | ||
| stringify!($val1), | ||
| stringify!($val2), | ||
| $val1, | ||
| $val2 | ||
| ); | ||
| return Err($error.into()); | ||
| } | ||
| }}; | ||
| } | ||
|
|
||
| /// | ||
| /// require a < b | ||
| /// | ||
| #[macro_export] | ||
| macro_rules! require_lt { | ||
| ( $val1:expr, $val2:expr, $error:expr) => {{ | ||
| if !($val1 < $val2) { | ||
| pinocchio_log::log!( | ||
| "require_lt!({}, {}) failed: {} < {}", | ||
| stringify!($val1), | ||
| stringify!($val2), | ||
| $val1, | ||
| $val2 | ||
| ); | ||
| return Err($error.into()); | ||
| } | ||
| }}; | ||
| } | ||
|
|
||
| /// | ||
| /// require a == b | ||
| /// | ||
| #[macro_export] | ||
| macro_rules! require_eq { | ||
| ( $val1:expr, $val2:expr, $error:expr) => {{ | ||
| if !($val1 == $val2) { | ||
| pinocchio_log::log!( | ||
| "require_eq!({}, {}) failed: {} == {}", | ||
| stringify!($val1), | ||
| stringify!($val2), | ||
| $val1, | ||
| $val2 | ||
| ); | ||
| return Err($error.into()); | ||
| } | ||
| }}; | ||
| } | ||
|
|
||
| /// | ||
| /// require a >= b | ||
| /// | ||
| #[macro_export] | ||
| macro_rules! require_ge { | ||
| ( $val1:expr, $val2:expr, $error:expr) => {{ | ||
| if !($val1 >= $val2) { | ||
| pinocchio_log::log!( | ||
| "require_ge!({}, {}) failed: {} >= {}", | ||
| stringify!($val1), | ||
| stringify!($val2), | ||
| $val1, | ||
| $val2 | ||
| ); | ||
| return Err($error.into()); | ||
| } | ||
| }}; | ||
| } | ||
|
|
||
| /// | ||
| /// require a > b | ||
| /// | ||
| #[macro_export] | ||
| macro_rules! require_gt { | ||
| ( $val1:expr, $val2:expr, $error:expr) => {{ | ||
| if !($val1 > $val2) { | ||
| pinocchio_log::log!( | ||
| "require_gt!({}, {}) failed: {} > {}", | ||
| stringify!($val1), | ||
| stringify!($val2), | ||
| $val1, | ||
| $val2 | ||
| ); | ||
| return Err($error.into()); | ||
| } | ||
| }}; | ||
| } | ||
|
|
||
| /// | ||
| /// require exactly n accounts | ||
| /// | ||
| #[macro_export] | ||
| macro_rules! require_n_accounts { | ||
| ( $accounts:expr, $n:literal) => {{ | ||
| match $accounts.len().cmp(&$n) { | ||
| core::cmp::Ordering::Less => { | ||
| pinocchio_log::log!( | ||
| "Need {} accounts, but got less ({}) accounts", | ||
| $n, | ||
| $accounts.len() | ||
| ); | ||
| return Err(pinocchio::error::ProgramError::NotEnoughAccountKeys); | ||
| } | ||
| core::cmp::Ordering::Equal => TryInto::<&[_; $n]>::try_into($accounts) | ||
| .map_err(|_| $crate::error::EphemeralSplError::InfallibleError)?, | ||
| core::cmp::Ordering::Greater => { | ||
| pinocchio_log::log!( | ||
| "Need {} accounts, but got more ({}) accounts", | ||
| $n, | ||
| $accounts.len() | ||
| ); | ||
| return Err($crate::error::EphemeralSplError::TooManyAccountKeys.into()); | ||
| } | ||
| } | ||
| }}; | ||
| } | ||
|
|
||
| /// | ||
| /// require n-or-more accounts, more is returned as slice. | ||
| /// | ||
| #[macro_export] | ||
| macro_rules! require_n_accounts_with_optionals { | ||
| ( $accounts:expr, $n:literal) => {{ | ||
| match $accounts.len().cmp(&$n) { | ||
| core::cmp::Ordering::Less => { | ||
| pinocchio_log::log!( | ||
| "Need {} accounts, but got less ({}) accounts", | ||
| $n, | ||
| $accounts.len() | ||
| ); | ||
| return Err(pinocchio::error::ProgramError::NotEnoughAccountKeys); | ||
| } | ||
| _ => { | ||
| let (exact, optionals) = $accounts.split_at($n); | ||
|
|
||
| ( | ||
| TryInto::<&[_; $n]>::try_into(exact) | ||
| .map_err(|_| $crate::error::EphemeralSplError::InfallibleError)?, | ||
| optionals, | ||
| ) | ||
| } | ||
| } | ||
| }}; | ||
| } | ||
|
|
||
| /// | ||
| /// require n-or-more accounts, more is ignored. | ||
| /// | ||
| #[macro_export] | ||
| macro_rules! require_n_accounts_with_ignored { | ||
| ( $accounts:expr, $n:literal) => {{ | ||
| match $accounts.len().cmp(&$n) { | ||
| core::cmp::Ordering::Less => { | ||
| pinocchio_log::log!( | ||
| "Need {} accounts, but got less ({}) accounts", | ||
| $n, | ||
| $accounts.len() | ||
| ); | ||
| return Err(pinocchio::error::ProgramError::NotEnoughAccountKeys); | ||
| } | ||
| _ => { | ||
| let (exact, _) = $accounts.split_at($n); | ||
| TryInto::<&[_; $n]>::try_into(exact) | ||
| .map_err(|_| $crate::error::EphemeralSplError::InfallibleError)? | ||
| } | ||
| } | ||
| }}; | ||
| } | ||
|
|
||
| /// | ||
| /// require Option to be Some | ||
| /// | ||
| #[macro_export] | ||
| macro_rules! require_some { | ||
| ($option:expr, $error:expr) => {{ | ||
| match $option { | ||
| Some(val) => val, | ||
| None => return Err($error.into()), | ||
| } | ||
| }}; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.