konfigkoll_script 0.1.16

Scripting language for Konfigkoll (not for direct public use)
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

//! System information gathering
use super::error::KResult;
use konfigkoll_hwinfo::pci::PciDevice;
use konfigkoll_hwinfo::pci::PciIdDb;
use rune::Any;
use rune::ContextError;
use rune::Module;
use sysinfo::CpuRefreshKind;
use sysinfo::MemoryRefreshKind;

/// System info access
#[derive(Debug, Any)]
#[rune(item = ::sysinfo)]
struct SysInfo {
    inner: sysinfo::System,
    cpu_loaded: bool,
    pci_devices: Option<Vec<PciDevice>>,
    // TODO: Needed for future functionality
    #[allow(dead_code)]
    pci_db: Option<PciIdDb>,
}

impl SysInfo {
    /// Create a new system info object
    #[rune::function(path = Self::new)]
    fn new() -> Self {
        Self {
            inner: sysinfo::System::new(),
            cpu_loaded: false,
            pci_devices: None,
            pci_db: None,
        }
    }

    /// Total amount of memory in kB
    #[rune::function]
    fn total_memory(&mut self) -> u64 {
        self.inner
            .refresh_memory_specifics(MemoryRefreshKind::nothing().with_ram());
        self.inner.total_memory() / 1024
    }

    /// The system architecture
    #[rune::function]
    fn architecture(&self) -> Option<String> {
        Some(sysinfo::System::cpu_arch())
    }

    /// The kernel version
    #[rune::function]
    fn kernel(&self) -> Option<String> {
        sysinfo::System::kernel_version()
    }

    /// The DNS hostname
    #[rune::function]
    fn host_name(&self) -> Option<String> {
        sysinfo::System::host_name()
    }

    /// The OS ID
    ///
    /// On Linux this corresponds to the `ID` field in `/etc/os-release`.
    #[rune::function]
    fn os_id(&self) -> String {
        sysinfo::System::distribution_id()
    }

    /// The OS version
    ///
    /// On Linux this corresponds to the `VERSION_ID` field in `/etc/os-release`
    /// or `DISTRIB_RELEASE` in `/etc/lsb-release`.
    #[rune::function]
    fn os_version(&self) -> Option<String> {
        sysinfo::System::os_version()
    }

    /// Number of physical CPU cores
    #[rune::function]
    fn cpu_cores(&self) -> Option<usize> {
        sysinfo::System::physical_core_count()
    }

    /// Get the CPU vendor
    #[rune::function]
    fn cpu_vendor_id(&mut self) -> Option<String> {
        if !self.cpu_loaded {
            self.inner.refresh_cpu_specifics(CpuRefreshKind::default());
            self.cpu_loaded = true;
        }
        self.inner
            .cpus()
            .first()
            .map(|cpu| cpu.vendor_id().to_string())
    }

    /// Get the CPU vendor
    #[rune::function]
    fn cpu_brand(&mut self) -> Option<String> {
        if !self.cpu_loaded {
            self.inner.refresh_cpu_specifics(CpuRefreshKind::default());
            self.cpu_loaded = true;
        }
        self.inner.cpus().first().map(|cpu| cpu.brand().to_string())
    }

    #[rune::function]
    /// Get the PCI devices
    fn pci_devices(&mut self) -> KResult<Vec<PciDevice>> {
        if self.pci_devices.is_none() {
            let devices = konfigkoll_hwinfo::pci::load_pci_devices()?;
            self.pci_devices = Some(devices.collect());
        }

        self.pci_devices
            .clone()
            .ok_or_else(|| eyre::eyre!("Failed to load PCI devices").into())
    }
}

#[rune::module(::sysinfo)]
/// Various functions to get system information
pub(crate) fn module() -> Result<Module, ContextError> {
    let mut m = Module::from_meta(module_meta)?;
    m.ty::<SysInfo>()?;
    m.function_meta(SysInfo::new)?;
    m.function_meta(SysInfo::architecture)?;
    m.function_meta(SysInfo::kernel)?;
    m.function_meta(SysInfo::host_name)?;
    m.function_meta(SysInfo::os_id)?;
    m.function_meta(SysInfo::os_version)?;
    m.function_meta(SysInfo::cpu_cores)?;
    m.function_meta(SysInfo::total_memory)?;
    m.function_meta(SysInfo::cpu_vendor_id)?;
    m.function_meta(SysInfo::cpu_brand)?;
    m.function_meta(SysInfo::pci_devices)?;
    m.ty::<PciDevice>()?;
    m.ty::<PciIdDb>()?;
    Ok(m)
}