tool: add support for split program image

Signed-off-by: Nick Spinale <nick@nickspinale.com>

Author: nspin

tool/microkit/src/elf.rs

@@ -6,6 +6,7 @@
 
 use crate::sel4::PageSize;
 use crate::util::{bytes_to_struct, round_down, struct_to_bytes};
+use std::borrow::Cow;
 use std::collections::HashMap;
 use std::fs::{self, metadata, File};
 use std::io::Write;
@@ -190,9 +191,20 @@ pub struct ElfFile {
 
 impl ElfFile {
     pub fn from_path(path: &Path) -> Result<ElfFile, String> {
+        Self::from_split_paths(path, None)
+    }
+
+    pub fn from_split_paths(
+        path: &Path,
+        path_for_symbols: Option<&Path>,
+    ) -> Result<ElfFile, String> {
         let reader = ElfFileReader::from_path(path)?;
+        let reader_for_symbols = match path_for_symbols {
+            Some(path_for_symbols) => Cow::Owned(ElfFileReader::from_path(path_for_symbols)?),
+            None => Cow::Borrowed(&reader),
+        };
         let segments = reader.segments()?;
-        let symbols = reader.symbols()?;
+        let symbols = reader_for_symbols.symbols()?;
         Ok(ElfFile {
             path: path.to_owned(),
             word_size: reader.word_size,

tool/microkit/src/main.rs

@@ -518,7 +518,22 @@ fn main() -> Result<(), String> {
     for pd in &system.protection_domains {
         match get_full_path(&pd.program_image, &search_paths) {
             Some(path) => {
-                system_elfs.push(ElfFile::from_path(&path)?);
+                let path_for_symbols = pd
+                    .program_image_for_symbols
+                    .as_ref()
+                    .map(|path_suffix| {
+                        get_full_path(path_suffix, &search_paths).ok_or_else(|| {
+                            format!(
+                                "unable to find program image for symbols: '{}'",
+                                path_suffix.display()
+                            )
+                        })
+                    })
+                    .transpose()?;
+                system_elfs.push(ElfFile::from_split_paths(
+                    &path,
+                    path_for_symbols.as_deref(),
+                )?);
             }
             None => {
                 return Err(format!(

tool/microkit/src/sdf.rs

@@ -225,6 +225,7 @@ pub struct ProtectionDomain {
     pub stack_size: u64,
     pub smc: bool,
     pub program_image: PathBuf,
+    pub program_image_for_symbols: Option<PathBuf>,
     pub maps: Vec<SysMap>,
     pub irqs: Vec<SysIrq>,
     pub ioports: Vec<IOPort>,
@@ -536,6 +537,7 @@ impl ProtectionDomain {
         let mut child_pds = Vec::new();
 
         let mut program_image = None;
+        let mut program_image_for_symbols = None;
         let mut virtual_machine = None;
 
         // Default to minimum priority
@@ -560,7 +562,7 @@ impl ProtectionDomain {
 
             match child.tag_name().name() {
                 "program_image" => {
-                    check_attributes(xml_sdf, &child, &["path"])?;
+                    check_attributes(xml_sdf, &child, &["path", "path_for_symbols"])?;
                     if program_image.is_some() {
                         return Err(value_error(
                             xml_sdf,
@@ -571,6 +573,9 @@ impl ProtectionDomain {
 
                     let program_image_path = checked_lookup(xml_sdf, &child, "path")?;
                     program_image = Some(Path::new(program_image_path).to_path_buf());
+
+                    program_image_for_symbols =
+                        child.attribute("path_for_symbols").map(PathBuf::from);
                 }
                 "map" => {
                     let map_max_vaddr = config.pd_map_max_vaddr(stack_size);
@@ -973,6 +978,7 @@ impl ProtectionDomain {
             stack_size,
             smc,
             program_image: program_image.unwrap(),
+            program_image_for_symbols,
             maps,
             irqs,
             ioports,