created a bench tool for votes (#4085)

* bench-vote implementation 

* addressed some feedback from Behzad

* use second as opposed to nano-sec for ease

Cargo.toml

@@ -24,6 +24,7 @@ members = [
     "banks-server",
     "bench-streamer",
     "bench-tps",
+    "bench-vote",
     "bloom",
     "bucket_map",
     "builtins",

bench-vote/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "solana-bench-vote"
+publish = false
+version = { workspace = true }
+authors = { workspace = true }
+repository = { workspace = true }
+homepage = { workspace = true }
+license = { workspace = true }
+edition = { workspace = true }
+
+[dependencies]
+bincode = { workspace = true }
+clap = { version = "3.1.5", features = ["cargo"] }
+crossbeam-channel = { workspace = true }
+solana-client = { workspace = true }
+solana-connection-cache = { workspace = true }
+solana-net-utils = { workspace = true }
+solana-sdk = { workspace = true }
+solana-streamer = { workspace = true }
+solana-version = { workspace = true }
+solana-vote-program = { workspace = true }
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]

bench-vote/src/main.rs

@@ -0,0 +1,315 @@
+#![allow(clippy::arithmetic_side_effects)]
+
+use {
+    clap::{crate_description, crate_name, Arg, Command},
+    crossbeam_channel::unbounded,
+    solana_client::connection_cache::ConnectionCache,
+    solana_connection_cache::client_connection::ClientConnection,
+    solana_net_utils::bind_to_unspecified,
+    solana_sdk::{
+        hash::Hash, message::Message, signature::Keypair, signer::Signer, transaction::Transaction,
+    },
+    solana_streamer::{
+        packet::PacketBatchRecycler,
+        streamer::{receiver, PacketBatchReceiver, StreamerReceiveStats},
+    },
+    solana_vote_program::{vote_instruction, vote_state::Vote},
+    std::{
+        cmp::max,
+        net::{IpAddr, Ipv4Addr, SocketAddr, UdpSocket},
+        sync::{
+            atomic::{AtomicBool, AtomicUsize, Ordering},
+            Arc,
+        },
+        thread::{self, spawn, JoinHandle, Result},
+        time::{Duration, Instant, SystemTime},
+    },
+};
+
+const SINK_REPORT_INTERVAL: Duration = Duration::from_secs(5);
+const SINK_RECEIVE_TIMEOUT: Duration = Duration::from_secs(1);
+const SOCKET_RECEIVE_TIMEOUT: Duration = Duration::from_secs(1);
+const COALESCE_TIME: Duration = Duration::from_millis(1);
+
+fn sink(
+    exit: Arc<AtomicBool>,
+    received_size: Arc<AtomicUsize>,
+    receiver: PacketBatchReceiver,
+    verbose: bool,
+) -> JoinHandle<()> {
+    spawn(move || {
+        let mut last_report = Instant::now();
+        while !exit.load(Ordering::Relaxed) {
+            if let Ok(packet_batch) = receiver.recv_timeout(SINK_RECEIVE_TIMEOUT) {
+                received_size.fetch_add(packet_batch.len(), Ordering::Relaxed);
+            }
+
+            let count = received_size.load(Ordering::Relaxed);
+
+            if verbose && last_report.elapsed() > SINK_REPORT_INTERVAL {
+                println!("Received txns count: {count}");
+                last_report = Instant::now();
+            }
+        }
+    })
+}
+
+const TRANSACTIONS_PER_THREAD: u64 = 1_000_000; // Number of transactions per thread
+
+fn main() -> Result<()> {
+    let matches = Command::new(crate_name!())
+        .about(crate_description!())
+        .version(solana_version::version!())
+        .arg(
+            Arg::new("num-recv-sockets")
+                .long("num-recv-sockets")
+                .value_name("NUM")
+                .takes_value(true)
+                .help("Use NUM receive sockets"),
+        )
+        .arg(
+            Arg::new("num-producers")
+                .long("num-producers")
+                .value_name("NUM")
+                .takes_value(true)
+                .help("Use this many producer threads."),
+        )
+        .arg(
+            Arg::new("server-only")
+                .long("server-only")
+                .takes_value(false)
+                .help("Run the bench tool as a server only."),
+        )
+        .arg(
+            Arg::new("client-only")
+                .long("client-only")
+                .takes_value(false)
+                .requires("server-address")
+                .help("Run the bench tool as a client only."),
+        )
+        .arg(
+            Arg::with_name("server-address")
+                .short('n')
+                .long("server-address")
+                .value_name("HOST:PORT")
+                .takes_value(true)
+                .validator(|arg| solana_net_utils::is_host_port(arg.to_string()))
+                .help("The destination streamer address to which the client will send transactions to"),
+        )
+        .arg(
+            Arg::new("use-connection-cache")
+                .long("use-connection-cache")
+                .takes_value(false)
+                .help("Use this many producer threads."),
+        )
+        .arg(
+            Arg::new("verbose")
+                .long("verbose")
+                .takes_value(false)
+                .help("Show verbose messages."),
+        )
+        .get_matches();
+
+    let mut num_sockets = 1usize;
+    if let Some(n) = matches.value_of("num-recv-sockets") {
+        num_sockets = max(num_sockets, n.to_string().parse().expect("integer"));
+    }
+
+    let num_producers: u64 = matches.value_of_t("num-producers").unwrap_or(4);
+
+    let use_connection_cache = matches.is_present("use-connection-cache");
+
+    let server_only = matches.is_present("server-only");
+    let client_only = matches.is_present("client-only");
+    let verbose = matches.is_present("verbose");
+
+    let destination = matches.is_present("server-address").then(|| {
+        let addr = matches
+            .value_of("server-address")
+            .expect("Destination must be set when --client-only is used");
+        solana_net_utils::parse_host_port(addr).expect("Expecting a valid server address")
+    });
+
+    let port = destination.map_or(0, |addr| addr.port());
+    let ip_addr = destination.map_or(IpAddr::V4(Ipv4Addr::UNSPECIFIED), |addr| addr.ip());
+
+    let (exit, read_threads, sink_threads, destination) = if !client_only {
+        let exit = Arc::new(AtomicBool::new(false));
+
+        let mut read_channels = Vec::new();
+        let mut read_threads = Vec::new();
+        let recycler = PacketBatchRecycler::default();
+        let (port, read_sockets) = solana_net_utils::multi_bind_in_range(
+            ip_addr,
+            (port, port + num_sockets as u16),
+            num_sockets,
+        )
+        .unwrap();
+        let stats = Arc::new(StreamerReceiveStats::new("bench-streamer-test"));
+        for read in read_sockets {
+            read.set_read_timeout(Some(SOCKET_RECEIVE_TIMEOUT)).unwrap();
+
+            let (s_reader, r_reader) = unbounded();
+            read_channels.push(r_reader);
+            read_threads.push(receiver(
+                "solRcvrBenStrmr".to_string(),
+                Arc::new(read),
+                exit.clone(),
+                s_reader,
+                recycler.clone(),
+                stats.clone(),
+                COALESCE_TIME, // coalesce
+                true,          // use_pinned_memory
+                None,          // in_vote_only_mode
+                false,         // is_staked_service
+            ));
+        }
+
+        let received_size = Arc::new(AtomicUsize::new(0));
+        let sink_threads: Vec<_> = read_channels
+            .into_iter()
+            .map(|r_reader| sink(exit.clone(), received_size.clone(), r_reader, verbose))
+            .collect();
+
+        let destination = SocketAddr::new(ip_addr, port);
+        println!("Running server at {destination:?}");
+        (
+            Some(exit),
+            Some(read_threads),
+            Some(sink_threads),
+            destination,
+        )
+    } else {
+        (None, None, None, destination.unwrap())
+    };
+
+    let start = SystemTime::now();
+
+    let producer_threads =
+        (!server_only).then(|| producer(destination, num_producers, use_connection_cache, verbose));
+
+    producer_threads
+        .into_iter()
+        .flatten()
+        .try_for_each(JoinHandle::join)?;
+
+    if !server_only {
+        if let Some(exit) = exit {
+            exit.store(true, Ordering::Relaxed);
+        }
+    } else {
+        println!("To stop the server, please press ^C");
+    }
+
+    read_threads
+        .into_iter()
+        .flatten()
+        .try_for_each(JoinHandle::join)?;
+    sink_threads
+        .into_iter()
+        .flatten()
+        .try_for_each(JoinHandle::join)?;
+
+    if !(server_only) {
+        let elapsed = start.elapsed().unwrap();
+        let ftime = elapsed.as_nanos() as f64 / 1_000_000_000.0;
+        let fcount = (TRANSACTIONS_PER_THREAD * num_producers) as f64;
+
+        println!(
+            "Performance: {:?}/s, count: {fcount}, time in second: {ftime}",
+            fcount / ftime
+        );
+    }
+    Ok(())
+}
+
+#[derive(Clone)]
+enum Transporter {
+    Cache(Arc<ConnectionCache>),
+    DirectSocket(Arc<UdpSocket>),
+}
+
+fn producer(
+    sock: SocketAddr,
+    num_producers: u64,
+    use_connection_cache: bool,
+    verbose: bool,
+) -> Vec<JoinHandle<()>> {
+    println!("Running clients against {sock:?}");
+    let transporter = if use_connection_cache {
+        Transporter::Cache(Arc::new(ConnectionCache::with_udp(
+            "connection_cache_vote_udp",
+            1, // connection_pool_size
+        )))
+    } else {
+        Transporter::DirectSocket(Arc::new(bind_to_unspecified().unwrap()))
+    };
+
+    let mut handles = vec![];
+
+    let current_slot: u64 = 0;
+
+    let identity_keypair = Keypair::new(); // Replace with loaded keypair
+
+    for _i in 0..num_producers {
+        let transporter = transporter.clone();
+        let identity_keypair = identity_keypair.insecure_clone();
+        handles.push(thread::spawn(move || {
+            // Generate and send transactions
+            for _j in 0..TRANSACTIONS_PER_THREAD {
+                // Create a vote instruction
+                let vote = Vote {
+                    slots: vec![current_slot], // Voting for the current slot
+                    hash: Hash::new_unique(),
+                    timestamp: None, // Optional timestamp
+                };
+
+                let vote_instruction = vote_instruction::vote(
+                    &identity_keypair.pubkey(),
+                    &identity_keypair.pubkey(),
+                    vote,
+                );
+
+                // Build the transaction
+                let message = Message::new(&[vote_instruction], Some(&identity_keypair.pubkey()));
+
+                let recent_blockhash = Hash::new_unique();
+                let transaction = Transaction::new(&[&identity_keypair], message, recent_blockhash);
+
+                let serialized_transaction = bincode::serialize(&transaction).unwrap();
+
+                match &transporter {
+                    Transporter::Cache(cache) => {
+                        let connection = cache.get_connection(&sock);
+
+                        match connection.send_data(&serialized_transaction) {
+                            Ok(_) => {
+                                if verbose {
+                                    println!("Sent transaction successfully");
+                                }
+                            }
+                            Err(ex) => {
+                                println!("Error sending transaction {ex:?}");
+                            }
+                        }
+                    }
+                    Transporter::DirectSocket(socket) => {
+                        match socket.send_to(&serialized_transaction, sock) {
+                            Ok(_) => {
+                                if verbose {
+                                    println!(
+                                        "Sent transaction via direct socket successfully {sock:?}"
+                                    );
+                                }
+                            }
+                            Err(ex) => {
+                                println!("Error sending transaction {ex:?}");
+                            }
+                        }
+                    }
+                }
+            }
+        }));
+    }
+    handles
+}