// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

//! Network throughput performance test.
//!
//! Boots an Alpine Linux VM with a NIC backed by Consomme,
//! installs iperf3, and measures TCP throughput (Gbps) and UDP packet
//! rate (pps) between the guest and host across multiple iterations.
//! Uses warm mode: the VM is booted once and reused for all iterations.
//!
//! Supports both VMBus (NETVSP) and virtio-net (PCIe) NIC backends.

use crate::report::MetricResult;
use anyhow::Context as _;
use petri::pipette::cmd;

use petri_artifacts_common::tags::MachineArch;

/// Which NIC backend to use for the network test.
#[derive(Debug, Clone, Copy, PartialEq, Eq, clap::ValueEnum)]
pub enum NicBackend {
    /// VMBus synthetic NIC (NETVSP).
    Vmbus,
    /// Virtio-net on PCIe.
    #[value(name = "virtio-net")]
    VirtioNet,
}

impl std::fmt::Display for NicBackend {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        use clap::ValueEnum;
        f.write_str(self.to_possible_value().unwrap().get_name())
    }
}

/// Network throughput test via iperf3.
pub struct NetworkTest {
    /// Print guest serial output and take framebuffer screenshots.
    pub diag: bool,
    /// Which NIC backend to test.
    pub nic: NicBackend,
    /// If set, record per-phase perf traces in this directory.
    pub perf_dir: Option<std::path::PathBuf>,
}

/// State kept across warm iterations: the running VM and pipette agent.
pub struct NetworkTestState {
    vm: petri::PetriVm<petri::openvmm::OpenVmmPetriBackend>,
    agent: petri::pipette::PipetteClient,
    /// The host's real IP address, reachable from the guest via Consomme NAT.
    host_ip: String,
    /// Async driver for timers.
    driver: pal_async::DefaultDriver,
}

fn build_firmware(resolver: &petri::ArtifactResolver<'_>) -> petri::Firmware {
    use petri_artifacts_vmm_test::artifacts::test_vhd::ALPINE_3_23_AARCH64;
    use petri_artifacts_vmm_test::artifacts::test_vhd::ALPINE_3_23_X64;

    let arch = MachineArch::host();
    let boot_image = match arch {
        MachineArch::X86_64 => petri::BootImageConfig::from_vhd(resolver.require(ALPINE_3_23_X64)),
        MachineArch::Aarch64 => {
            petri::BootImageConfig::from_vhd(resolver.require(ALPINE_3_23_AARCH64))
        }
    };
    let guest = petri::UefiGuest::Vhd(boot_image);
    petri::Firmware::uefi(resolver, arch, guest)
}

/// Register artifacts needed by the network test.
pub fn register_artifacts(resolver: &petri::ArtifactResolver<'_>) {
    let firmware = build_firmware(resolver);
    petri::PetriVmArtifacts::<petri::openvmm::OpenVmmPetriBackend>::new(
        resolver,
        firmware,
        MachineArch::host(),
        true,
    );
}

impl crate::harness::WarmPerfTest for NetworkTest {
    type State = NetworkTestState;

    fn name(&self) -> &str {
        match self.nic {
            NicBackend::Vmbus => "network_vmbus",
            NicBackend::VirtioNet => "network_virtio",
        }
    }

    fn warmup_iterations(&self) -> u32 {
        1
    }

    async fn setup(
        &self,
        resolver: &petri::ArtifactResolver<'_>,
        driver: &pal_async::DefaultDriver,
    ) -> anyhow::Result<NetworkTestState> {
        // Verify host iperf3 is available (cross-platform).
        let status = std::process::Command::new("iperf3")
            .arg("--version")
            .stdout(std::process::Stdio::null())
            .stderr(std::process::Stdio::null())
            .status();
        anyhow::ensure!(
            status.is_ok_and(|s| s.success()),
            "iperf3 not found on host — install it (e.g. apt install iperf3)"
        );

        let firmware = build_firmware(resolver);

        let artifacts = petri::PetriVmArtifacts::<petri::openvmm::OpenVmmPetriBackend>::new(
            resolver,
            firmware,
            MachineArch::host(),
            true,
        )
        .context("firmware/arch not compatible with OpenVMM backend")?;

        let mut post_test_hooks = Vec::new();
        let log_source = crate::log_source();
        let params = petri::PetriTestParams {
            test_name: "network",
            logger: &log_source,
            post_test_hooks: &mut post_test_hooks,
        };

        let mut builder = petri::PetriVmBuilder::new(params, artifacts, driver)?
            .with_processor_topology(petri::ProcessorTopology {
                vp_count: 2,
                ..Default::default()
            })
            .with_memory(petri::MemoryConfig {
                startup_bytes: 2 * 1024 * 1024 * 1024,
                ..Default::default()
            })
            .modify_backend({
                let nic = self.nic;
                move |c| match nic {
                    NicBackend::Vmbus => c.with_nic(),
                    NicBackend::VirtioNet => c
                        .with_pcie_root_topology(1, 1, 1)
                        .with_virtio_nic("s0rc0rp0"),
                }
            });

        if !self.diag {
            builder = builder.without_screenshots();
        }

        let (vm, agent) = builder.run().await.context("failed to boot Alpine VM")?;

        // Bring up networking inside the guest.
        let sh = agent.unix_shell();
        cmd!(sh, "ifconfig eth0 up").run().await?;
        cmd!(sh, "udhcpc eth0").run().await?;

        // Install iperf3.
        cmd!(sh, "apk add iperf3")
            .run()
            .await
            .context("failed to install iperf3 — host may need internet access")?;

        // Detect the host's real IP. Consomme NATs outbound traffic, so the
        // guest can reach the host at its real address (not the virtual
        // gateway 10.0.0.1).
        let host_ip = detect_host_ip().context("failed to detect host IP")?;
        tracing::info!(host_ip = %host_ip, "detected host IP for iperf3 server");

        Ok(NetworkTestState {
            vm,
            agent,
            host_ip,
            driver: driver.clone(),
        })
    }

    async fn run_once(&self, state: &mut NetworkTestState) -> anyhow::Result<Vec<MetricResult>> {
        let mut metrics = Vec::new();
        let label = self.nic;
        let pid = state.vm.backend().pid();
        let mut recorder = crate::harness::PerfRecorder::new(self.perf_dir.as_deref(), pid)?;
        let mut timer = pal_async::timer::PolledTimer::new(&state.driver);
        let perf_delay = std::time::Duration::from_millis(500);

        // TCP TX (guest sends to host)
        let name = format!("net_{label}_tcp_tx_gbps");
        recorder.start(&name)?;
        // Give perf time to attach.
        timer.sleep(perf_delay).await;
        let m = run_iperf3_test(
            &state.agent,
            &state.host_ip,
            5201,
            &name,
            IperfMode::TcpTx,
            &mut timer,
        )
        .await
        .context("TCP TX test failed")?;
        recorder.stop()?;
        metrics.push(m);

        // TCP RX (host sends to guest, -R flag)
        let name = format!("net_{label}_tcp_rx_gbps");
        recorder.start(&name)?;
        timer.sleep(perf_delay).await;
        let m = run_iperf3_test(
            &state.agent,
            &state.host_ip,
            5202,
            &name,
            IperfMode::TcpRx,
            &mut timer,
        )
        .await
        .context("TCP RX test failed")?;
        recorder.stop()?;
        metrics.push(m);

        // UDP TX (guest sends to host)
        let name = format!("net_{label}_udp_tx_pps");
        recorder.start(&name)?;
        timer.sleep(perf_delay).await;
        let m = run_iperf3_test(
            &state.agent,
            &state.host_ip,
            5203,
            &name,
            IperfMode::UdpTx,
            &mut timer,
        )
        .await
        .context("UDP TX test failed")?;
        recorder.stop()?;
        metrics.push(m);

        // Note: UDP RX (-R reverse mode) is not included because iperf3's
        // reverse UDP mode is unreliable over Consomme (control socket
        // closes before the test completes).

        Ok(metrics)
    }

    async fn teardown(&self, state: NetworkTestState) -> anyhow::Result<()> {
        state.agent.power_off().await?;
        state.vm.wait_for_clean_teardown().await?;
        Ok(())
    }
}

/// Which iperf3 test variant to run.
enum IperfMode {
    /// TCP, guest sends to host.
    TcpTx,
    /// TCP, host sends to guest (-R).
    TcpRx,
    /// UDP, guest sends to host.
    UdpTx,
}

/// Spawn a host iperf3 server, run the guest client, collect JSON results.
async fn run_iperf3_test(
    agent: &petri::pipette::PipetteClient,
    host_ip: &str,
    port: u16,
    metric_name: &str,
    mode: IperfMode,
    timer: &mut pal_async::timer::PolledTimer,
) -> anyhow::Result<MetricResult> {
    // Spawn host iperf3 server (serves one client then exits).
    let server = spawn_iperf3_server(port)?;

    // Brief delay to let the server bind.
    timer.sleep(std::time::Duration::from_millis(500)).await;

    // Build guest client command.
    let port_str = port.to_string();

    // Run guest iperf3 client. Use ignore_status() because iperf3 may
    // exit non-zero even when data was exchanged (e.g., control socket
    // issues in reverse mode). We parse results from the host server JSON.
    let sh = agent.unix_shell();
    match mode {
        IperfMode::TcpTx => {
            cmd!(sh, "iperf3 -c {host_ip} -p {port_str} -t 10 -J")
                .ignore_status()
                .run()
                .await
        }
        IperfMode::TcpRx => {
            cmd!(sh, "iperf3 -c {host_ip} -p {port_str} -t 10 -R -J")
                .ignore_status()
                .run()
                .await
        }
        IperfMode::UdpTx => {
            cmd!(sh, "iperf3 -c {host_ip} -p {port_str} -t 10 -u -b 0 -J")
                .ignore_status()
                .run()
                .await
        }
    }
    .with_context(|| format!("guest iperf3 client failed for {metric_name}"))?;

    // Collect host server output (it exits after one client session).
    let output = server
        .wait_with_output()
        .context("failed to wait for iperf3 server")?;

    let json =
        String::from_utf8(output.stdout).context("iperf3 server output is not valid UTF-8")?;

    // iperf3 server may exit non-zero on cleanup even when data was collected.
    // Log a warning but try to parse the JSON anyway.
    if !output.status.success() {
        tracing::warn!(
            status = %output.status,
            stderr = %String::from_utf8_lossy(&output.stderr),
            "iperf3 server exited non-zero (may still have valid JSON)"
        );
    }

    anyhow::ensure!(
        !json.is_empty(),
        "iperf3 server produced no output for {metric_name}"
    );

    tracing::debug!(metric = metric_name, json = %json, "raw iperf3 output");

    // Parse metrics from the *host server* JSON. We use host-side rather
    // than guest-side output because (a) the guest client output goes
    // through pipette and isn't easily captured, and (b) in -R (reverse)
    // mode the client sometimes exits before flushing complete JSON.
    //
    // Field mapping (host perspective):
    //   TcpTx (guest sends): host received -> sum_received
    //   TcpRx (host sends):  host sent     -> sum_sent
    match mode {
        IperfMode::TcpTx => parse_tcp_throughput(&json, metric_name, false),
        IperfMode::TcpRx => parse_tcp_throughput(&json, metric_name, true),
        IperfMode::UdpTx => parse_udp_pps(&json, metric_name),
    }
}

fn spawn_iperf3_server(port: u16) -> anyhow::Result<std::process::Child> {
    std::process::Command::new("iperf3")
        .args(["-s", "-1", "-J", "-p", &port.to_string()])
        .stdout(std::process::Stdio::piped())
        .stderr(std::process::Stdio::piped())
        .spawn()
        .context("failed to spawn iperf3 server")
}

/// Detect the host's primary IP address by finding the default route source.
///
/// Works cross-platform (Linux, macOS, Windows) by using a UDP socket connect
/// to query the kernel routing table without sending any traffic.
fn detect_host_ip() -> anyhow::Result<String> {
    let socket = std::net::UdpSocket::bind("0.0.0.0:0")
        .context("failed to bind UDP socket for host IP detection")?;
    socket
        .connect("1.1.1.1:80")
        .context("failed to connect UDP socket (no default route?)")?;
    let addr = socket
        .local_addr()
        .context("failed to get local address of UDP socket")?;
    Ok(addr.ip().to_string())
}

/// Parse TCP throughput from iperf3 JSON output.
///
/// For TX (guest sends): use `end.sum_received` (what the host received).
/// For RX (`-R`, host sends): use `end.sum_sent` (what the host sent).
fn parse_tcp_throughput(json: &str, metric_name: &str, sent: bool) -> anyhow::Result<MetricResult> {
    let v: serde_json::Value = serde_json::from_str(json).context("failed to parse iperf3 JSON")?;

    let field = if sent { "sum_sent" } else { "sum_received" };
    let bps = v["end"][field]["bits_per_second"].as_f64();

    // Fall back to the other field if the primary is missing or zero.
    let alt_field = if sent { "sum_received" } else { "sum_sent" };
    let bps = match bps {
        Some(v) if v > 0.0 => v,
        _ => v["end"][alt_field]["bits_per_second"]
            .as_f64()
            .with_context(|| {
                tracing::error!(json = %json, "failed to find bits_per_second in iperf3 TCP output");
                format!("missing bits_per_second in iperf3 output for {metric_name}")
            })?,
    };

    let gbps = bps / 1_000_000_000.0;
    Ok(MetricResult {
        name: metric_name.to_string(),
        unit: "Gbps".to_string(),
        value: gbps,
    })
}

/// Parse UDP packets-per-second from iperf3 JSON output.
fn parse_udp_pps(json: &str, metric_name: &str) -> anyhow::Result<MetricResult> {
    let v: serde_json::Value = serde_json::from_str(json).context("failed to parse iperf3 JSON")?;

    let packets = v["end"]["sum"]["packets"].as_f64();
    let seconds = v["end"]["sum"]["seconds"].as_f64();

    let pps = match (packets, seconds) {
        (Some(p), Some(s)) if s > 0.0 => p / s,
        _ => {
            // Fall back: try bits_per_second with default packet size (1460 bytes).
            let bps = v["end"]["sum"]["bits_per_second"].as_f64().with_context(|| {
                tracing::error!(json = %json, "failed to find packets/seconds in iperf3 UDP output");
                format!("missing packets or seconds in iperf3 output for {metric_name}")
            })?;
            // Approximate: default UDP datagram is 1460 bytes.
            bps / (1460.0 * 8.0)
        }
    };

    Ok(MetricResult {
        name: metric_name.to_string(),
        unit: "pps".to_string(),
        value: pps,
    })
}
