glean 67.3.0

Glean SDK Rust language bindings
Documentation
// Copyright (c) 2017 The Rust Project Developers
// Copyright (c) 2018-2020 The Rust Secure Code Working Group
// Licensed under the MIT License.
// Original license:
// https://github.com/rustsec/rustsec/blob/2a080f173ad9d8ac7fa260f0a3a6aebf0000de06/platforms/LICENSE-MIT
//
// Permission is hereby granted, free of charge, to any
// person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the
// Software without restriction, including without
// limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software
// is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice
// shall be included in all copies or substantial portions
// of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
// ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
// SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

//! Detect and expose `target_arch` as a constant

#[cfg(target_arch = "aarch64")]
/// `target_arch` when building this crate: `aarch64`
pub const ARCH: &str = "aarch64";

#[cfg(target_arch = "arm")]
/// `target_arch` when building this crate: `arm`
pub const ARCH: &str = "arm";

#[cfg(target_arch = "x86")]
/// `target_arch` when building this crate: `x86`
pub const ARCH: &str = "x86";

#[cfg(target_arch = "x86_64")]
/// `target_arch` when building this crate: `x86_64`
pub const ARCH: &str = "x86_64";

#[cfg(target_arch = "powerpc64")]
/// `target_arch` when building this crate: `powerpc64`
pub const ARCH: &str = "powerpc64";

#[cfg(target_arch = "riscv64")]
/// `target_arch` when building this crate: `riscv64`
pub const ARCH: &str = "riscv64";

#[cfg(target_arch = "mips")]
/// `target_arch` when building this crate: `mips`
pub const ARCH: &str = "mips";

#[cfg(target_arch = "loongarch64")]
/// `target_arch` when building this crate: `loongarch64`
pub const ARCH: &str = "loongarch64";

#[cfg(target_arch = "s390x")]
/// `target_arch` when building this crate: `s390x`
pub const ARCH: &str = "s390x";

#[cfg(not(any(
    target_arch = "aarch64",
    target_arch = "arm",
    target_arch = "x86",
    target_arch = "x86_64",
    target_arch = "powerpc64",
    target_arch = "riscv64",
    target_arch = "mips",
    target_arch = "loongarch64",
    target_arch = "s390x",
)))]
/// `target_arch` when building this crate: unknown!
pub const ARCH: &str = "Unknown";

#[cfg(any(target_os = "macos", target_os = "windows"))]
/// Returns Darwin kernel version for MacOS, or NT Kernel version for Windows
pub fn get_os_version() -> String {
    whatsys::kernel_version().unwrap_or_else(|| "Unknown".to_owned())
}

#[cfg(target_os = "android")]
mod android {
    use std::ffi::{c_char, c_int, CStr, CString};

    const PROP_VALUE_MAX: usize = 92;

    extern "C" {
        fn __system_property_get(name: *const c_char, value: *mut c_char) -> c_int;
    }

    pub fn get_os_version() -> String {
        let mut value: [c_char; PROP_VALUE_MAX] = [0; PROP_VALUE_MAX];
        let prop_key = CString::new("ro.build.version.release").unwrap();
        let length =
            unsafe { __system_property_get(prop_key.as_ptr(), value.as_mut_slice().as_mut_ptr()) };
        if length > 0 {
            // SAFETY: the value is guaranteed to be nul-terminated, and valid until this is converted to an owned
            // String (within this scope).
            unsafe { CStr::from_ptr(value.as_slice().as_ptr()) }
                .to_str()
                .ok()
        } else {
            None
        }
        .unwrap_or("Unknown")
        .to_owned()
    }
}

#[cfg(target_os = "android")]
pub use android::get_os_version;

#[cfg(not(any(
    target_os = "android",
    target_os = "linux",
    target_os = "macos",
    target_os = "windows"
)))]
/// Returns "Unknown" for platforms other than Linux, MacOS or Windows
pub fn get_os_version() -> String {
    "Unknown".to_owned()
}

#[cfg(target_os = "linux")]
/// Returns Linux kernel version, in the format of <Major>.<Minor> e.g. 5.8
pub fn get_os_version() -> String {
    parse_linux_os_string(whatsys::kernel_version().unwrap_or_else(|| "Unknown".to_owned()))
}

#[cfg(target_os = "windows")]
/// Returns the Windows build number, e.g. 22000
pub fn get_windows_build_number() -> Option<i64> {
    match whatsys::windows_build_number() {
        // Cast to i64 to work with QuantityMetric type
        Some(i) => Some(i as i64),
        _ => None,
    }
}

#[cfg(not(target_os = "windows"))]
/// Returns None, for non-Windows operating systems
pub fn get_windows_build_number() -> Option<i64> {
    None
}

#[cfg(target_os = "linux")]
fn parse_linux_os_string(os_str: String) -> String {
    os_str.split('.').take(2).collect::<Vec<&str>>().join(".")
}

#[test]
#[cfg(target_os = "linux")]
fn parse_fixed_linux_os_string() {
    let alpine_os_string = "4.12.0-rc6-g48ec1f0-dirty".to_owned();
    assert_eq!(parse_linux_os_string(alpine_os_string), "4.12");
    let centos_os_string = "3.10.0-514.16.1.el7.x86_64".to_owned();
    assert_eq!(parse_linux_os_string(centos_os_string), "3.10");
    let ubuntu_os_string = "5.8.0-44-generic".to_owned();
    assert_eq!(parse_linux_os_string(ubuntu_os_string), "5.8");
}