mountpoint-s3-fs 0.9.3

Mountpoint S3 main library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use std::env;

use anyhow::{Context, anyhow};
use mountpoint_s3_client::instance_info::InstanceInfo;

use crate::s3::config::Region;

mod instance_throughput;
use instance_throughput::get_instance_throughput;

/// Determine the maximum network throughput for the current instance using IMDS. Returns an error
/// if the instance type either cannot be retrieved using the IMDS client or does not have a known
/// network throughput.
pub fn network_throughput(instance_info: &InstanceInfo) -> anyhow::Result<f64> {
    let instance_type = instance_info
        .instance_type()
        .map_err(|e| anyhow!("failed to get instance type: {e}"))?;
    let throughput = get_maximum_network_throughput(instance_type).context("failed to get network throughput")?;
    Ok(throughput)
}

pub fn get_maximum_network_throughput(ec2_instance_type: &str) -> anyhow::Result<f64> {
    get_instance_throughput(ec2_instance_type).ok_or_else(|| {
        anyhow!(
            "no throughput configuration for EC2 instance type {}",
            ec2_instance_type
        )
    })
}

/// Determine the region using the following sources (in order):
///  * `--region` flag (user-provided),
///  * `AWS_REGION` environment variable (user-provided),
///  * EC2 instance region (using the IMDS client),
///  * default region (us-east-1).
pub fn get_region(instance_info: &InstanceInfo, region_override: Option<String>) -> Region {
    const DEFAULT_REGION: &str = "us-east-1";

    // Use --region (user-provided).
    if let Some(region) = region_override {
        return Region::new_user_specified(region);
    }

    // Use AWS_REGION (user-provided).
    if let Some(region) = env_region() {
        tracing::debug!("using AWS_REGION: {region} (environment variable)");
        return Region::new_user_specified(region);
    }

    // Use instance region, if available.
    if let Ok(region) = instance_info.region() {
        tracing::debug!("using instance region {}", region);
        return Region::new_inferred(region.to_owned());
    }

    // Use default region.
    tracing::debug!("using default region {}", DEFAULT_REGION);
    Region::new_inferred(DEFAULT_REGION.to_owned())
}

fn env_region() -> Option<String> {
    env::var_os("AWS_REGION").map(|val| val.to_string_lossy().into())
}

#[cfg(test)]
mod tests {
    use super::*;
    use test_case::test_case;

    #[test_case("c4.large", None)] // We let "Moderate" fall through to default
    #[test_case("c5.large", Some(10.0))]
    #[test_case("c5n.large", Some(25.0))]
    #[test_case("c5n.18xlarge", Some(100.0))]
    #[test_case("c6i.large", Some(12.5))]
    #[test_case("p4d.24xlarge", Some(400.0))] // 4x 100 Gigabit
    #[test_case("trn1.32xlarge", Some(800.0))] // 8x 100 Gigabit
    #[test_case("dl1.24xlarge", Some(400.0))] // 4x 100 Gigabit
    fn test_get_maximum_network_throughput(instance_type: &str, throughput: Option<f64>) {
        let actual = get_maximum_network_throughput(instance_type).ok();
        assert_eq!(actual, throughput);
    }
}