Add higher level NumaInfo type in platform

Author: IsaacWoods

src/platform/mod.rs

@@ -1,4 +1,5 @@
 pub mod interrupt;
+pub mod numa;
 pub mod pci;
 
 pub use interrupt::InterruptModel;

src/platform/numa.rs

@@ -0,0 +1,87 @@
+use crate::{
+    AcpiTables,
+    Handler,
+    sdt::{
+        slit::{DistanceMatrix, Slit},
+        srat::{LocalApicAffinityFlags, MemoryAffinityFlags, Srat, SratEntry},
+    },
+};
+use alloc::{alloc::Global, vec::Vec};
+use core::alloc::Allocator;
+
+/// Information about the setup of NUMA (Non-Uniform Memory Architecture) resources within the
+/// sytem.
+pub struct NumaInfo<A: Allocator = Global> {
+    pub processor_affinity: Vec<ProcessorAffinity, A>,
+    pub memory_affinity: Vec<MemoryAffinity, A>,
+    pub num_proximity_domains: usize,
+    pub distance_matrix: Vec<u8, A>,
+}
+
+impl NumaInfo<Global> {
+    pub fn new(tables: AcpiTables<impl Handler>) -> NumaInfo<Global> {
+        Self::new_in(tables, Global)
+    }
+}
+
+impl<A: Allocator + Clone> NumaInfo<A> {
+    pub fn new_in(tables: AcpiTables<impl Handler>, allocator: A) -> NumaInfo<A> {
+        let mut processor_affinity = Vec::new_in(allocator.clone());
+        let mut memory_affinity = Vec::new_in(allocator.clone());
+
+        if let Some(srat) = tables.find_table::<Srat>() {
+            for entry in srat.get().entries() {
+                match entry {
+                    SratEntry::LocalApicAffinity(entry) => processor_affinity.push(ProcessorAffinity {
+                        local_apic_id: entry.apic_id as u32,
+                        proximity_domain: entry.proximity_domain(),
+                        is_enabled: { entry.flags }.contains(LocalApicAffinityFlags::ENABLED),
+                    }),
+                    SratEntry::LocalApicX2Affinity(entry) => processor_affinity.push(ProcessorAffinity {
+                        local_apic_id: entry.x2apic_id,
+                        proximity_domain: entry.proximity_domain,
+                        is_enabled: { entry.flags }.contains(LocalApicAffinityFlags::ENABLED),
+                    }),
+                    SratEntry::MemoryAffinity(entry) => memory_affinity.push(MemoryAffinity {
+                        base_address: entry.base_address(),
+                        length: entry.length(),
+                        proximity_domain: entry.proximity_domain,
+                        is_enabled: { entry.flags }.contains(MemoryAffinityFlags::ENABLED),
+                        is_hot_pluggable: { entry.flags }.contains(MemoryAffinityFlags::HOT_PLUGGABLE),
+                        is_non_volatile: { entry.flags }.contains(MemoryAffinityFlags::NON_VOLATILE),
+                    }),
+                    _ => (),
+                }
+            }
+        }
+
+        let (num_proximity_domains, distance_matrix) = if let Some(slit) = tables.find_table::<Slit>() {
+            (slit.get().num_proximity_domains as usize, slit.get().matrix_raw().to_vec_in(allocator.clone()))
+        } else {
+            (0, Vec::new_in(allocator.clone()))
+        };
+
+        NumaInfo { processor_affinity, memory_affinity, num_proximity_domains, distance_matrix }
+    }
+
+    pub fn distance_matrix(&self) -> DistanceMatrix<'_> {
+        DistanceMatrix { num_proximity_domains: self.num_proximity_domains as u64, matrix: &self.distance_matrix }
+    }
+}
+
+#[derive(Clone, Debug)]
+pub struct ProcessorAffinity {
+    pub local_apic_id: u32,
+    pub proximity_domain: u32,
+    pub is_enabled: bool,
+}
+
+#[derive(Clone, Debug)]
+pub struct MemoryAffinity {
+    pub base_address: u64,
+    pub length: u64,
+    pub proximity_domain: u32,
+    pub is_enabled: bool,
+    pub is_hot_pluggable: bool,
+    pub is_non_volatile: bool,
+}

src/sdt/slit.rs

@@ -26,7 +26,11 @@ unsafe impl AcpiTable for Slit {
 }
 
 impl Slit {
-    pub fn matrix(self: Pin<&Self>) -> &[u8] {
+    pub fn matrix(self: Pin<&Self>) -> DistanceMatrix<'_> {
+        DistanceMatrix { num_proximity_domains: self.num_proximity_domains, matrix: self.matrix_raw() }
+    }
+
+    pub fn matrix_raw(self: Pin<&Self>) -> &[u8] {
         let mut num_entries = self.num_proximity_domains * self.num_proximity_domains;
         if (mem::size_of::<Slit>() + num_entries as usize * num_entries as usize * mem::size_of::<u8>())
             > self.header.length as usize
@@ -40,11 +44,17 @@ impl Slit {
             slice::from_raw_parts(ptr.byte_add(mem::size_of::<Slit>()), num_entries as usize)
         }
     }
+}
+
+pub struct DistanceMatrix<'a> {
+    pub num_proximity_domains: u64,
+    pub matrix: &'a [u8],
+}
 
-    pub fn entry(self: Pin<&Self>, i: u32, j: u32) -> Option<u8> {
+impl DistanceMatrix<'_> {
+    pub fn distance(&self, i: u32, j: u32) -> Option<u8> {
         if i as u64 <= self.num_proximity_domains && j as u64 <= self.num_proximity_domains {
-            let matrix = self.matrix();
-            Some(matrix[i as usize + j as usize * self.num_proximity_domains as usize])
+            Some(self.matrix[i as usize + j as usize * self.num_proximity_domains as usize])
         } else {
             None
         }

src/sdt/srat.rs

@@ -122,12 +122,19 @@ pub struct LocalApicAffinity {
     pub header: EntryHeader,
     pub proximity_domain_low: u8,
     pub apic_id: u8,
-    pub flags: u32,
+    pub flags: LocalApicAffinityFlags,
     pub local_sapic_eid: u8,
     pub proximity_domain_high: [u8; 3],
     pub clock_domain: u32,
 }
 
+bitflags::bitflags! {
+    #[derive(Clone, Copy, Debug)]
+    pub struct LocalApicAffinityFlags: u32 {
+        const ENABLED = 1;
+    }
+}
+
 impl LocalApicAffinity {
     pub fn proximity_domain(&self) -> u32 {
         u32::from_le_bytes([
@@ -150,10 +157,19 @@ pub struct MemoryAffinity {
     pub length_low: u32,
     pub length_high: u32,
     _reserved1: u32,
-    pub flags: u32,
+    pub flags: MemoryAffinityFlags,
     _reserved2: u64,
 }
 
+bitflags::bitflags! {
+    #[derive(Clone, Copy, Debug)]
+    pub struct MemoryAffinityFlags: u32 {
+        const ENABLED = 1;
+        const HOT_PLUGGABLE = 1 << 1;
+        const NON_VOLATILE = 1 << 2;
+    }
+}
+
 impl MemoryAffinity {
     pub fn base_address(&self) -> u64 {
         let mut address = self.base_address_low as u64;
@@ -175,7 +191,7 @@ pub struct LocalApicX2Affinity {
     _reserved0: u16,
     pub proximity_domain: u32,
     pub x2apic_id: u32,
-    pub flags: u32,
+    pub flags: LocalApicAffinityFlags,
     pub clock_domain: u32,
     _reserved1: u32,
 }