414 lines
16 KiB
Rust
414 lines
16 KiB
Rust
use {
|
|
crate::immutable_deserialized_packet::ImmutableDeserializedPacket,
|
|
solana_perf::packet::Packet,
|
|
solana_runtime::{
|
|
block_cost_limits,
|
|
cost_tracker::{CostTracker, CostTrackerError},
|
|
},
|
|
solana_sdk::{pubkey::Pubkey, transaction::SanitizedTransaction},
|
|
std::sync::Arc,
|
|
};
|
|
|
|
/// `ForwardBatch` to have half of default cost_tracker limits, as smaller batch
|
|
/// allows better granularity in composing forwarding transactions; e.g.,
|
|
/// transactions in each batch are potentially more evenly distributed across accounts.
|
|
const FORWARDED_BLOCK_COMPUTE_RATIO: u32 = 2;
|
|
/// this number divided by`FORWARDED_BLOCK_COMPUTE_RATIO` is the total blocks to forward.
|
|
/// To accommodate transactions without `compute_budget` instruction, which will
|
|
/// have default 200_000 compute units, it has 100 batches as default to forward
|
|
/// up to 12_000 such transaction. (120 such transactions fill up a batch, 100
|
|
/// batches allows 12_000 transactions)
|
|
const DEFAULT_NUMBER_OF_BATCHES: u32 = 100;
|
|
|
|
/// `ForwardBatch` represents one forwardable batch of transactions with a
|
|
/// limited number of total compute units
|
|
#[derive(Debug)]
|
|
pub struct ForwardBatch {
|
|
cost_tracker: CostTracker,
|
|
// `forwardable_packets` keeps forwardable packets in a vector in its
|
|
// original fee prioritized order
|
|
forwardable_packets: Vec<Arc<ImmutableDeserializedPacket>>,
|
|
}
|
|
|
|
impl Default for ForwardBatch {
|
|
/// default ForwardBatch has cost_tracker with default limits
|
|
fn default() -> Self {
|
|
Self::new(1)
|
|
}
|
|
}
|
|
|
|
impl ForwardBatch {
|
|
/// `ForwardBatch` keeps forwardable packets in a vector in its original fee prioritized order,
|
|
/// Number of packets are limited by `cost_tracker` with customized `limit_ratio` to lower
|
|
/// (when `limit_ratio` > 1) `cost_tracker`'s default limits.
|
|
/// Lower limits yield smaller batch for forwarding.
|
|
fn new(limit_ratio: u32) -> Self {
|
|
let mut cost_tracker = CostTracker::default();
|
|
cost_tracker.set_limits(
|
|
block_cost_limits::MAX_WRITABLE_ACCOUNT_UNITS.saturating_div(limit_ratio as u64),
|
|
block_cost_limits::MAX_BLOCK_UNITS.saturating_div(limit_ratio as u64),
|
|
block_cost_limits::MAX_VOTE_UNITS.saturating_div(limit_ratio as u64),
|
|
);
|
|
Self {
|
|
cost_tracker,
|
|
forwardable_packets: Vec::default(),
|
|
}
|
|
}
|
|
|
|
fn try_add(
|
|
&mut self,
|
|
write_lock_accounts: &[Pubkey],
|
|
compute_units: u64,
|
|
immutable_packet: Arc<ImmutableDeserializedPacket>,
|
|
) -> Result<u64, CostTrackerError> {
|
|
let res = self.cost_tracker.try_add_requested_cus(
|
|
write_lock_accounts,
|
|
compute_units,
|
|
immutable_packet.is_simple_vote(),
|
|
);
|
|
|
|
if res.is_ok() {
|
|
self.forwardable_packets.push(immutable_packet);
|
|
}
|
|
res
|
|
}
|
|
|
|
pub fn get_forwardable_packets(&self) -> impl Iterator<Item = &Packet> {
|
|
self.forwardable_packets
|
|
.iter()
|
|
.map(|immutable_packet| immutable_packet.original_packet())
|
|
}
|
|
|
|
pub fn len(&self) -> usize {
|
|
self.forwardable_packets.len()
|
|
}
|
|
|
|
pub fn is_empty(&self) -> bool {
|
|
self.forwardable_packets.is_empty()
|
|
}
|
|
}
|
|
|
|
/// To avoid forward queue being saturated by transactions for single hot account,
|
|
/// the forwarder will group and send prioritized transactions by account limit
|
|
/// to allow transactions on non-congested accounts to be forwarded alongside higher fee
|
|
/// transactions that saturate those highly demanded accounts.
|
|
#[derive(Debug)]
|
|
pub struct ForwardPacketBatchesByAccounts {
|
|
// Forwardable packets are staged in number of batches, each batch is limited
|
|
// by cost_tracker on both account limit and block limits. Those limits are
|
|
// set as `limit_ratio` of regular block limits to facilitate quicker iteration.
|
|
forward_batches: Vec<ForwardBatch>,
|
|
// Valid packets are iterated from high priority to low, then try to add into
|
|
// forwarding account buckets by calling `try_add_packet()` only when this flag is true.
|
|
// The motivation of this is during bot spamming, buffer is likely to be filled with
|
|
// transactions have higher priority and write to same account(s), other lower priority
|
|
// transactions will not make into buffer, saves from checking similar transactions if
|
|
// it exit as soon as first transaction failed to fit in forwarding buckets.
|
|
accepting_packets: bool,
|
|
}
|
|
|
|
impl ForwardPacketBatchesByAccounts {
|
|
pub fn new_with_default_batch_limits() -> Self {
|
|
Self::new(FORWARDED_BLOCK_COMPUTE_RATIO, DEFAULT_NUMBER_OF_BATCHES)
|
|
}
|
|
|
|
pub fn new(limit_ratio: u32, number_of_batches: u32) -> Self {
|
|
let forward_batches = (0..number_of_batches)
|
|
.map(|_| ForwardBatch::new(limit_ratio))
|
|
.collect();
|
|
Self {
|
|
forward_batches,
|
|
accepting_packets: true,
|
|
}
|
|
}
|
|
|
|
pub fn try_add_packet(
|
|
&mut self,
|
|
sanitized_transaction: &SanitizedTransaction,
|
|
packet: Arc<ImmutableDeserializedPacket>,
|
|
) -> bool {
|
|
if self.accepting_packets {
|
|
// get write_lock_accounts
|
|
let message = sanitized_transaction.message();
|
|
let write_lock_accounts: Vec<_> = message
|
|
.account_keys()
|
|
.iter()
|
|
.enumerate()
|
|
.filter_map(|(i, account_key)| {
|
|
if message.is_writable(i) {
|
|
Some(*account_key)
|
|
} else {
|
|
None
|
|
}
|
|
})
|
|
.collect();
|
|
|
|
// get requested CUs
|
|
let requested_cu = packet.compute_unit_limit();
|
|
|
|
// try to fill into forward batches
|
|
self.accepting_packets =
|
|
self.add_packet_to_batches(&write_lock_accounts, requested_cu, packet);
|
|
}
|
|
self.accepting_packets
|
|
}
|
|
|
|
pub fn iter_batches(&self) -> impl Iterator<Item = &ForwardBatch> {
|
|
self.forward_batches.iter()
|
|
}
|
|
|
|
/// transaction will try to be filled into 'batches', if can't fit into first batch
|
|
/// due to cost_tracker (eg., exceeding account limit or block limit), it will try
|
|
/// next batch until either being added to one of 'bucket' or not being forwarded.
|
|
fn add_packet_to_batches(
|
|
&mut self,
|
|
write_lock_accounts: &[Pubkey],
|
|
compute_units: u64,
|
|
immutable_packet: Arc<ImmutableDeserializedPacket>,
|
|
) -> bool {
|
|
for forward_batch in self.forward_batches.iter_mut() {
|
|
if forward_batch
|
|
.try_add(write_lock_accounts, compute_units, immutable_packet.clone())
|
|
.is_ok()
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
false
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use {
|
|
super::*,
|
|
crate::unprocessed_packet_batches::DeserializedPacket,
|
|
solana_runtime::transaction_priority_details::TransactionPriorityDetails,
|
|
solana_sdk::{
|
|
feature_set::FeatureSet, hash::Hash, signature::Keypair, system_transaction,
|
|
transaction::SimpleAddressLoader,
|
|
},
|
|
std::sync::Arc,
|
|
};
|
|
|
|
fn build_deserialized_packet_for_test(
|
|
priority: u64,
|
|
write_to_account: &Pubkey,
|
|
compute_unit_limit: u64,
|
|
) -> DeserializedPacket {
|
|
let tx =
|
|
system_transaction::transfer(&Keypair::new(), write_to_account, 1, Hash::new_unique());
|
|
let packet = Packet::from_data(None, tx).unwrap();
|
|
DeserializedPacket::new_with_priority_details(
|
|
packet,
|
|
TransactionPriorityDetails {
|
|
priority,
|
|
compute_unit_limit,
|
|
},
|
|
)
|
|
.unwrap()
|
|
}
|
|
|
|
#[test]
|
|
fn test_try_add_to_forward_batch() {
|
|
// set test batch limit to be 1 millionth of regular block limit
|
|
let limit_ratio = 1_000_000u32;
|
|
// set requested_cu to be half of batch account limit
|
|
let requested_cu =
|
|
block_cost_limits::MAX_WRITABLE_ACCOUNT_UNITS.saturating_div(limit_ratio as u64);
|
|
|
|
let mut forward_batch = ForwardBatch::new(limit_ratio);
|
|
|
|
let write_lock_accounts = vec![Pubkey::new_unique(), Pubkey::new_unique()];
|
|
let packet = build_deserialized_packet_for_test(10, &write_lock_accounts[1], requested_cu);
|
|
// first packet will be successful
|
|
assert!(forward_batch
|
|
.try_add(
|
|
&write_lock_accounts,
|
|
requested_cu,
|
|
packet.immutable_section().clone()
|
|
)
|
|
.is_ok());
|
|
assert_eq!(1, forward_batch.forwardable_packets.len());
|
|
// second packet will hit account limit, therefore not added
|
|
assert!(forward_batch
|
|
.try_add(
|
|
&write_lock_accounts,
|
|
requested_cu,
|
|
packet.immutable_section().clone()
|
|
)
|
|
.is_err());
|
|
assert_eq!(1, forward_batch.forwardable_packets.len());
|
|
}
|
|
|
|
#[test]
|
|
fn test_try_add_packet_to_batches() {
|
|
solana_logger::setup();
|
|
// set test batch limit to be 1 millionth of regular block limit
|
|
let limit_ratio = 1_000_000u32;
|
|
let number_of_batches = 2;
|
|
// set requested_cu to be half of batch account limit
|
|
let requested_cu =
|
|
block_cost_limits::MAX_WRITABLE_ACCOUNT_UNITS.saturating_div(limit_ratio as u64);
|
|
|
|
let mut forward_packet_batches_by_accounts =
|
|
ForwardPacketBatchesByAccounts::new(limit_ratio, number_of_batches);
|
|
|
|
// initially both batches are empty
|
|
{
|
|
let mut batches = forward_packet_batches_by_accounts.iter_batches();
|
|
assert_eq!(0, batches.next().unwrap().len());
|
|
assert_eq!(0, batches.next().unwrap().len());
|
|
assert!(batches.next().is_none());
|
|
}
|
|
|
|
let hot_account = solana_sdk::pubkey::new_rand();
|
|
let other_account = solana_sdk::pubkey::new_rand();
|
|
let packet_high_priority =
|
|
build_deserialized_packet_for_test(10, &hot_account, requested_cu);
|
|
let packet_low_priority =
|
|
build_deserialized_packet_for_test(0, &other_account, requested_cu);
|
|
// with 4 packets, first 3 write to same hot_account with higher priority,
|
|
// the 4th write to other_account with lower priority;
|
|
// assert the 1st and 4th fit in first batch, the 2nd in 2nd batch and 3rd will be dropped.
|
|
|
|
// 1st high-priority packet added to 1st batch
|
|
{
|
|
forward_packet_batches_by_accounts.add_packet_to_batches(
|
|
&[hot_account],
|
|
requested_cu,
|
|
packet_high_priority.immutable_section().clone(),
|
|
);
|
|
let mut batches = forward_packet_batches_by_accounts.iter_batches();
|
|
assert_eq!(1, batches.next().unwrap().len());
|
|
assert_eq!(0, batches.next().unwrap().len());
|
|
assert!(batches.next().is_none());
|
|
}
|
|
|
|
// 2nd high-priority packet added to 2nd packet
|
|
{
|
|
forward_packet_batches_by_accounts.add_packet_to_batches(
|
|
&[hot_account],
|
|
requested_cu,
|
|
packet_high_priority.immutable_section().clone(),
|
|
);
|
|
let mut batches = forward_packet_batches_by_accounts.iter_batches();
|
|
assert_eq!(1, batches.next().unwrap().len());
|
|
assert_eq!(1, batches.next().unwrap().len());
|
|
}
|
|
|
|
// 3rd high-priority packet not included in forwarding
|
|
{
|
|
forward_packet_batches_by_accounts.add_packet_to_batches(
|
|
&[hot_account],
|
|
requested_cu,
|
|
packet_high_priority.immutable_section().clone(),
|
|
);
|
|
let mut batches = forward_packet_batches_by_accounts.iter_batches();
|
|
assert_eq!(1, batches.next().unwrap().len());
|
|
assert_eq!(1, batches.next().unwrap().len());
|
|
assert!(batches.next().is_none());
|
|
}
|
|
|
|
// 4rd lower priority packet added to 1st bucket on non-content account
|
|
{
|
|
forward_packet_batches_by_accounts.add_packet_to_batches(
|
|
&[other_account],
|
|
requested_cu,
|
|
packet_low_priority.immutable_section().clone(),
|
|
);
|
|
let mut batches = forward_packet_batches_by_accounts.iter_batches();
|
|
assert_eq!(2, batches.next().unwrap().len());
|
|
assert_eq!(1, batches.next().unwrap().len());
|
|
assert!(batches.next().is_none());
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_try_add_packet() {
|
|
solana_logger::setup();
|
|
// set test batch limit to be 1 millionth of regular block limit
|
|
let limit_ratio = 1_000_000u32;
|
|
let number_of_batches = 1;
|
|
// set requested_cu to be batch account limit
|
|
let requested_cu =
|
|
block_cost_limits::MAX_WRITABLE_ACCOUNT_UNITS.saturating_div(limit_ratio as u64);
|
|
|
|
let mut forward_packet_batches_by_accounts =
|
|
ForwardPacketBatchesByAccounts::new(limit_ratio, number_of_batches);
|
|
|
|
let hot_account = solana_sdk::pubkey::new_rand();
|
|
let other_account = solana_sdk::pubkey::new_rand();
|
|
|
|
// assert initially batch is empty, and accepting new packets
|
|
{
|
|
let mut batches = forward_packet_batches_by_accounts.iter_batches();
|
|
assert_eq!(0, batches.next().unwrap().len());
|
|
assert!(batches.next().is_none());
|
|
assert!(forward_packet_batches_by_accounts.accepting_packets);
|
|
}
|
|
|
|
// build a packet that would take up hot account limit, add it to batches
|
|
// assert it is added, and buffer still accepts more packets
|
|
{
|
|
let packet = build_deserialized_packet_for_test(10, &hot_account, requested_cu);
|
|
let tx = packet
|
|
.immutable_section()
|
|
.build_sanitized_transaction(
|
|
&Arc::new(FeatureSet::default()),
|
|
false, //votes_only,
|
|
SimpleAddressLoader::Disabled,
|
|
)
|
|
.unwrap();
|
|
assert!(forward_packet_batches_by_accounts
|
|
.try_add_packet(&tx, packet.immutable_section().clone()));
|
|
|
|
let mut batches = forward_packet_batches_by_accounts.iter_batches();
|
|
assert_eq!(1, batches.next().unwrap().len());
|
|
assert!(forward_packet_batches_by_accounts.accepting_packets);
|
|
}
|
|
|
|
// build a small packet that writes to hot account, try add it to batches
|
|
// assert it is not added, and buffer is no longer accept packets
|
|
{
|
|
let packet =
|
|
build_deserialized_packet_for_test(100, &hot_account, 1 /*requested_cu*/);
|
|
let tx = packet
|
|
.immutable_section()
|
|
.build_sanitized_transaction(
|
|
&Arc::new(FeatureSet::default()),
|
|
false, //votes_only,
|
|
SimpleAddressLoader::Disabled,
|
|
)
|
|
.unwrap();
|
|
assert!(!forward_packet_batches_by_accounts
|
|
.try_add_packet(&tx, packet.immutable_section().clone()));
|
|
|
|
let mut batches = forward_packet_batches_by_accounts.iter_batches();
|
|
assert_eq!(1, batches.next().unwrap().len());
|
|
assert!(!forward_packet_batches_by_accounts.accepting_packets);
|
|
}
|
|
|
|
// build a small packet that writes to other account, try add it to batches
|
|
// assert it is not added due to buffer is no longer accept any packet
|
|
{
|
|
let packet =
|
|
build_deserialized_packet_for_test(100, &other_account, 1 /*requested_cu*/);
|
|
let tx = packet
|
|
.immutable_section()
|
|
.build_sanitized_transaction(
|
|
&Arc::new(FeatureSet::default()),
|
|
false, //votes_only,
|
|
SimpleAddressLoader::Disabled,
|
|
)
|
|
.unwrap();
|
|
assert!(!forward_packet_batches_by_accounts
|
|
.try_add_packet(&tx, packet.immutable_section().clone()));
|
|
|
|
let mut batches = forward_packet_batches_by_accounts.iter_batches();
|
|
assert_eq!(1, batches.next().unwrap().len());
|
|
assert!(!forward_packet_batches_by_accounts.accepting_packets);
|
|
}
|
|
}
|
|
}
|