| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/nix-0.26.2/src/sys/sysinfo.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>sysinfo.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../nix/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../nix/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>libc::{<span class="self">self</span>, SI_LOAD_SHIFT}; |
| <span class="kw">use </span>std::time::Duration; |
| <span class="kw">use </span>std::{cmp, mem}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::errno::Errno; |
| <span class="kw">use </span><span class="kw">crate</span>::Result; |
| |
| <span class="doccomment">/// System info structure returned by `sysinfo`. |
| </span><span class="attribute">#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq)] |
| #[repr(transparent)] |
| </span><span class="kw">pub struct </span>SysInfo(libc::sysinfo); |
| |
| <span class="comment">// The fields are c_ulong on 32-bit linux, u64 on 64-bit linux; x32's ulong is u32 |
| </span><span class="attribute">#[cfg(all(target_arch = <span class="string">"x86_64"</span>, target_pointer_width = <span class="string">"32"</span>))] |
| </span><span class="kw">type </span>mem_blocks_t = u64; |
| <span class="attribute">#[cfg(not(all(target_arch = <span class="string">"x86_64"</span>, target_pointer_width = <span class="string">"32"</span>)))] |
| </span><span class="kw">type </span>mem_blocks_t = libc::c_ulong; |
| |
| <span class="kw">impl </span>SysInfo { |
| <span class="doccomment">/// Returns the load average tuple. |
| /// |
| /// The returned values represent the load average over time intervals of |
| /// 1, 5, and 15 minutes, respectively. |
| </span><span class="kw">pub fn </span>load_average(<span class="kw-2">&</span><span class="self">self</span>) -> (f64, f64, f64) { |
| ( |
| <span class="self">self</span>.<span class="number">0</span>.loads[<span class="number">0</span>] <span class="kw">as </span>f64 / (<span class="number">1 </span><< SI_LOAD_SHIFT) <span class="kw">as </span>f64, |
| <span class="self">self</span>.<span class="number">0</span>.loads[<span class="number">1</span>] <span class="kw">as </span>f64 / (<span class="number">1 </span><< SI_LOAD_SHIFT) <span class="kw">as </span>f64, |
| <span class="self">self</span>.<span class="number">0</span>.loads[<span class="number">2</span>] <span class="kw">as </span>f64 / (<span class="number">1 </span><< SI_LOAD_SHIFT) <span class="kw">as </span>f64, |
| ) |
| } |
| |
| <span class="doccomment">/// Returns the time since system boot. |
| </span><span class="comment">// The cast is not unnecessary on all platforms. |
| </span><span class="attribute">#[allow(clippy::unnecessary_cast)] |
| </span><span class="kw">pub fn </span>uptime(<span class="kw-2">&</span><span class="self">self</span>) -> Duration { |
| <span class="comment">// Truncate negative values to 0 |
| </span>Duration::from_secs(cmp::max(<span class="self">self</span>.<span class="number">0</span>.uptime, <span class="number">0</span>) <span class="kw">as </span>u64) |
| } |
| |
| <span class="doccomment">/// Current number of processes. |
| </span><span class="kw">pub fn </span>process_count(<span class="kw-2">&</span><span class="self">self</span>) -> u16 { |
| <span class="self">self</span>.<span class="number">0</span>.procs |
| } |
| |
| <span class="doccomment">/// Returns the amount of swap memory in Bytes. |
| </span><span class="kw">pub fn </span>swap_total(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="self">self</span>.scale_mem(<span class="self">self</span>.<span class="number">0</span>.totalswap) |
| } |
| |
| <span class="doccomment">/// Returns the amount of unused swap memory in Bytes. |
| </span><span class="kw">pub fn </span>swap_free(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="self">self</span>.scale_mem(<span class="self">self</span>.<span class="number">0</span>.freeswap) |
| } |
| |
| <span class="doccomment">/// Returns the total amount of installed RAM in Bytes. |
| </span><span class="kw">pub fn </span>ram_total(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="self">self</span>.scale_mem(<span class="self">self</span>.<span class="number">0</span>.totalram) |
| } |
| |
| <span class="doccomment">/// Returns the amount of completely unused RAM in Bytes. |
| /// |
| /// "Unused" in this context means that the RAM in neither actively used by |
| /// programs, nor by the operating system as disk cache or buffer. It is |
| /// "wasted" RAM since it currently serves no purpose. |
| </span><span class="kw">pub fn </span>ram_unused(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="self">self</span>.scale_mem(<span class="self">self</span>.<span class="number">0</span>.freeram) |
| } |
| |
| <span class="comment">// The cast is not unnecessary on all platforms. |
| </span><span class="attribute">#[allow(clippy::unnecessary_cast)] |
| </span><span class="kw">fn </span>scale_mem(<span class="kw-2">&</span><span class="self">self</span>, units: mem_blocks_t) -> u64 { |
| units <span class="kw">as </span>u64 * <span class="self">self</span>.<span class="number">0</span>.mem_unit <span class="kw">as </span>u64 |
| } |
| } |
| |
| <span class="doccomment">/// Returns system information. |
| /// |
| /// [See `sysinfo(2)`](https://man7.org/linux/man-pages/man2/sysinfo.2.html). |
| </span><span class="kw">pub fn </span>sysinfo() -> <span class="prelude-ty">Result</span><SysInfo> { |
| <span class="kw">let </span><span class="kw-2">mut </span>info = mem::MaybeUninit::uninit(); |
| <span class="kw">let </span>res = <span class="kw">unsafe </span>{ libc::sysinfo(info.as_mut_ptr()) }; |
| Errno::result(res).map(|<span class="kw">_</span>| <span class="kw">unsafe </span>{ SysInfo(info.assume_init()) }) |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="nix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
