zx/
system.rs

1// Copyright 2024 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::{Status, sys};
6use bitflags::bitflags;
7
8/// Retrieve the system memory page size in bytes.
9///
10/// Wraps the
11/// [zx_system_get_page_size](https://fuchsia.dev/fuchsia-src/reference/syscalls/system_get_page_size.md)
12/// syscall.
13pub fn system_get_page_size() -> u32 {
14    unsafe { sys::zx_system_get_page_size() }
15}
16
17/// Retrieve the system cache line size in bytes.
18///
19/// Wraps the
20/// [zx_system_get_dcache_line_size](https://fuchsia.dev/fuchsia-src/reference/syscalls/system_get_dcache_line_size.md)
21/// syscall.
22pub fn system_get_dcache_line_size() -> u32 {
23    unsafe { sys::zx_system_get_dcache_line_size() }
24}
25
26/// Get the amount of physical memory on the system, in bytes.
27///
28/// Wraps the
29/// [zx_system_get_physmem](https://fuchsia.dev/fuchsia-src/reference/syscalls/system_get_physmem)
30/// syscall.
31pub fn system_get_physmem() -> u64 {
32    unsafe { sys::zx_system_get_physmem() }
33}
34
35/// Get number of logical processors on the system.
36///
37/// Wraps the
38/// [zx_system_get_num_cpus](https://fuchsia.dev/fuchsia-src/reference/syscalls/system_get_num_cpus)
39/// syscall.
40pub fn system_get_num_cpus() -> u32 {
41    unsafe { sys::zx_system_get_num_cpus() }
42}
43
44/// The types of system features that may be requested.
45#[derive(Debug, Copy, Clone, Eq, PartialEq)]
46#[repr(u32)]
47pub enum FeatureKind {
48    HardwareBreakpointCount = sys::ZX_FEATURE_KIND_HW_BREAKPOINT_COUNT,
49    HardwareWatchpointCount = sys::ZX_FEATURE_KIND_HW_WATCHPOINT_COUNT,
50}
51
52impl Into<u32> for FeatureKind {
53    fn into(self) -> u32 {
54        match self {
55            FeatureKind::HardwareBreakpointCount => sys::ZX_FEATURE_KIND_HW_BREAKPOINT_COUNT,
56            FeatureKind::HardwareWatchpointCount => sys::ZX_FEATURE_KIND_HW_WATCHPOINT_COUNT,
57        }
58    }
59}
60
61// We use a placeholder type to disallow any other implementations
62// of the FeatureFlags trait below.
63mod private {
64    pub struct Internal;
65}
66
67// Trait which encodes the FeatureKind with the bitflags.
68pub trait FeatureFlags: bitflags::Flags {
69    fn kind(_: private::Internal) -> u32;
70}
71
72bitflags! {
73    #[repr(transparent)]
74    #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
75    pub struct VirtualMemoryFeatureFlags: u32 {
76        // VirtualMemoryKind flags
77        const VM_CAN_MAP_XOM = (1<<0);
78
79        // Allow the source to set any bits.
80        const _ = !0;
81    }
82}
83
84impl FeatureFlags for VirtualMemoryFeatureFlags {
85    fn kind(_: private::Internal) -> u32 {
86        sys::ZX_FEATURE_KIND_VM
87    }
88}
89
90bitflags! {
91    #[repr(transparent)]
92    #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
93    pub struct CpuFeatureFlags: u32 {
94
95        // CpuFeatureKind flags
96        const HAS_CPU_FEATURES = (1<<0);
97
98        // Target-architecture CpuFeatureKind flags
99        #[cfg(target_arch = "aarch64")]
100        const ARM64_FEATURE_ISA_FP = sys::ZX_ARM64_FEATURE_ISA_FP;
101        #[cfg(target_arch = "aarch64")]
102        const ARM64_FEATURE_ISA_ASIMD = sys::ZX_ARM64_FEATURE_ISA_ASIMD;
103        #[cfg(target_arch = "aarch64")]
104        const ARM64_FEATURE_ISA_AES = sys::ZX_ARM64_FEATURE_ISA_AES;
105        #[cfg(target_arch = "aarch64")]
106        const ARM64_FEATURE_ISA_PMULL = sys::ZX_ARM64_FEATURE_ISA_PMULL;
107        #[cfg(target_arch = "aarch64")]
108        const ARM64_FEATURE_ISA_SHA1 = sys::ZX_ARM64_FEATURE_ISA_SHA1;
109        #[cfg(target_arch = "aarch64")]
110        const ARM64_FEATURE_ISA_SHA256 = sys::ZX_ARM64_FEATURE_ISA_SHA256;
111        #[cfg(target_arch = "aarch64")]
112        const ARM64_FEATURE_ISA_CRC32 = sys::ZX_ARM64_FEATURE_ISA_CRC32;
113        #[cfg(target_arch = "aarch64")]
114        const ARM64_FEATURE_ISA_ATOMICS = sys::ZX_ARM64_FEATURE_ISA_ATOMICS;
115        #[cfg(target_arch = "aarch64")]
116        const ARM64_FEATURE_ISA_RDM = sys::ZX_ARM64_FEATURE_ISA_RDM;
117        #[cfg(target_arch = "aarch64")]
118        const ARM64_FEATURE_ISA_SHA3 = sys::ZX_ARM64_FEATURE_ISA_SHA3;
119        #[cfg(target_arch = "aarch64")]
120        const ARM64_FEATURE_ISA_SM3 = sys::ZX_ARM64_FEATURE_ISA_SM3;
121        #[cfg(target_arch = "aarch64")]
122        const ARM64_FEATURE_ISA_SM4 = sys::ZX_ARM64_FEATURE_ISA_SM4;
123        #[cfg(target_arch = "aarch64")]
124        const ARM64_FEATURE_ISA_DP = sys::ZX_ARM64_FEATURE_ISA_DP;
125        #[cfg(target_arch = "aarch64")]
126        const ARM64_FEATURE_ISA_DPB = sys::ZX_ARM64_FEATURE_ISA_DPB;
127        #[cfg(target_arch = "aarch64")]
128        const ARM64_FEATURE_ISA_FHM = sys::ZX_ARM64_FEATURE_ISA_FHM;
129        #[cfg(target_arch = "aarch64")]
130        const ARM64_FEATURE_ISA_TS = sys::ZX_ARM64_FEATURE_ISA_TS;
131        #[cfg(target_arch = "aarch64")]
132        const ARM64_FEATURE_ISA_RNDR = sys::ZX_ARM64_FEATURE_ISA_RNDR;
133        #[cfg(target_arch = "aarch64")]
134        const ARM64_FEATURE_ISA_SHA512 = sys::ZX_ARM64_FEATURE_ISA_SHA512;
135        #[cfg(target_arch = "aarch64")]
136        const ARM64_FEATURE_ISA_I8MM = sys::ZX_ARM64_FEATURE_ISA_I8MM;
137        #[cfg(target_arch = "aarch64")]
138        const ARM64_FEATURE_ISA_SVE = sys::ZX_ARM64_FEATURE_ISA_SVE;
139        #[cfg(target_arch = "aarch64")]
140        const ARM64_FEATURE_ISA_ARM32 = sys::ZX_ARM64_FEATURE_ISA_ARM32;
141
142        // This is an obsolete name for the same thing.
143        #[cfg(target_arch = "aarch64")]
144        const ARM64_FEATURE_ISA_SHA2 = sys::ZX_ARM64_FEATURE_ISA_SHA256;
145
146        // Allow the source to set any bits.
147        const _ = !0;
148    }
149}
150
151impl FeatureFlags for CpuFeatureFlags {
152    fn kind(_: private::Internal) -> u32 {
153        sys::ZX_FEATURE_KIND_CPU
154    }
155}
156
157bitflags! {
158    #[repr(transparent)]
159    #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
160    pub struct AddressTaggingFeatureFlags: u32 {
161        // arm64 address-tagging features
162        #[cfg(target_arch = "aarch64")]
163        const ARM64_FEATURE_ADDRESS_TAGGING_TBI = sys::ZX_ARM64_FEATURE_ADDRESS_TAGGING_TBI;
164
165        // Allow the source to set any bits.
166        const _ = !0;
167    }
168}
169
170impl FeatureFlags for AddressTaggingFeatureFlags {
171    fn kind(_: private::Internal) -> u32 {
172        sys::ZX_FEATURE_KIND_ADDRESS_TAGGING
173    }
174}
175
176/// Get supported hardware capabilities bitflags.
177///
178/// Wraps the
179/// [zx_system_get_features](https://fuchsia.dev/fuchsia-src/reference/syscalls/system_get_features)
180/// syscall.
181pub fn system_get_feature_flags<F: FeatureFlags>() -> Result<F, Status>
182where
183    F: bitflags::Flags<Bits = u32>,
184{
185    let mut raw_features: u32 = 0;
186    let access = private::Internal;
187    Status::ok(unsafe {
188        sys::zx_system_get_features(F::kind(access), &mut raw_features as *mut u32)
189    })
190    .and_then(|_status| Ok(F::from_bits_retain(raw_features)))
191}
192
193/// Get supported hardware capabilities counts.
194///
195/// Wraps the
196/// [zx_system_get_features](https://fuchsia.dev/fuchsia-src/reference/syscalls/system_get_features)
197/// syscall.
198pub fn system_get_feature_count(kind: FeatureKind) -> Result<u32, Status> {
199    let mut raw_features: u32 = 0;
200    Status::ok(unsafe { sys::zx_system_get_features(kind as u32, &mut raw_features as *mut u32) })
201        .and_then(|_status| Ok(raw_features))
202}
203
204#[cfg(test)]
205mod tests {
206    use super::*;
207
208    #[test]
209    fn system_get_features_cpu_kind() {
210        // Clear extra CPU feature flags
211        let result = system_get_feature_flags()
212            .map(|flags: CpuFeatureFlags| flags & CpuFeatureFlags::HAS_CPU_FEATURES);
213
214        // Only aarch64 should return Ok.
215        #[cfg(target_arch = "aarch64")]
216        assert_eq!(result, Ok(CpuFeatureFlags::HAS_CPU_FEATURES));
217
218        #[cfg(not(target_arch = "aarch64"))]
219        assert_eq!(result, Err(Status::NOT_SUPPORTED));
220    }
221
222    #[test]
223    fn system_get_features_other_kinds() {
224        assert!(system_get_feature_flags::<VirtualMemoryFeatureFlags>().is_ok());
225        assert!(system_get_feature_flags::<AddressTaggingFeatureFlags>().is_ok());
226        assert!(system_get_feature_count(FeatureKind::HardwareBreakpointCount).is_ok());
227        assert!(system_get_feature_count(FeatureKind::HardwareWatchpointCount).is_ok());
228    }
229}
zx/system.rs

zx/
system.rs
