Integrate a Rhai interpreter into faux-mgs.

Rust code changes:
  - add Rhai scripting as a feature (--features=rhaiscript)
  - add ArchiveInspector for access to RawHubrisArchive
  - add "system(argv) -> #{exit_code, stdout, stderr}" from std::process::Command
  - export faux-mgs paramsters to Rhai main.
  - run any faux-mgs command with "let result = faux_mgs(["arg0", .. "argN"]);
      - faux-mgs results are passed back to the script as a map even if they are simpler JSON.
  - ChronoPackage for time handling.
  - FilesystemPackage for file access.
  - EnvironmentPackage for env var access.
  - export "scriptdir" so that script can get other files relative to itself.
  - "verify_rot_image()" to verify a RoT image vs CFPA, CMPA.
  - vars available to main():
      - "argv" - script main's scope passing all remaining CLI args.
      - "rbi_default" - expose faux-mgs default "rot_boot_info" version
      - "interface" - pass the "--interface INTERFACE" value.
      - "reset_watchdog_timeout_ms" - pass that value to the script.
  - Route Rhai's debug function to the faux-mgs log.
      - The `debug("message")` function is routed to the faux-mgs slog logging.
        Prefixing a message with "crit|", "trace|", "error|", "warn|", "error|", or "debug|"
        will log at that corresponding level. Leaving off the prefix or using some other
        prefix will log at the debug level.
      - Rhai's `print()` still goes to stdout.

Rhai scripts:

scripts/util.rhai contains common script and faux-mgs support.
  - getops()
  - to_hexstring()
  - cstring_to_string(a)
  - array_to_mac(a)
  - ab_to_01(v)
  - env_expand(s, override)
  - rot_boot_info()
  - state()
  - caboose_value(component, slot, key)
  - get_device_cabooses()
  - rkth_to_key_name(rkth)
  - array_to_blob(a)
  - get_cmpa()
  - get_cfpa()
  - get_rot_keyset()

scripts/update-rollback.rhai
  - Only use MGS messages for testing, no humility or other APIs
  - perform happy path update and rollback from baseline to under-test images.

scripts/targets.json
  - an example configuration script for scripts/update-rollback.rhai

Author: lzrd

Cargo.lock

@@ -19,6 +19,7 @@ hubtools = { git = "https://github.com/oxidecomputer/hubtools.git", branch = "ma
 slog-error-chain = { git = "https://github.com/oxidecomputer/slog-error-chain.git", branch = "main", features = ["derive"] }
 
 anyhow = "1.0"
+async-recursion = "1.1.0"
 async-trait = "0.1"
 backoff = { version = "0.4.0", features = ["tokio"] }
 bitflags = "2.9.0"
@@ -30,13 +31,19 @@ glob = "0.3.2"
 hex = "0.4.3"
 hubpack = "0.1.2"
 humantime = "2.1.0"
+lpc55_areas = { git = "https://github.com/oxidecomputer/lpc55_support/", version = "0.2.3" }
+lpc55_sign = { git = "https://github.com/oxidecomputer/lpc55_support/", version = "0.3.0" }
 lru-cache = "0.1.2"
 lzss = "0.8"
 nix = { version = "0.27.1", features = ["net"] }
 omicron-zone-package = "0.11.0"
 once_cell = "1.21.1"
 paste = "1.0.15"
 rand = "0.8.5"
+rhai-chrono = { version = "^0" }
+rhai-env = "0.1.2"
+rhai-fs = { version = "0.1.3", features = ["metadata"] }
+rhai = { version = "1.21.0", features = ["serde", "metadata", "debugging"]}
 serde = { version = "1.0", default-features = false, features = ["derive"] }
 serde-big-array = "0.5.1"
 serde_json = "1.0.140"
@@ -53,10 +60,11 @@ static_assertions = "1.1.0"
 strum_macros = "0.25"
 string_cache = "0.8.8"
 termios = "0.3"
-thiserror = "1.0.69"
+thiserror = { version = "1.0.69", default-features = false }
 tokio = { version = "1.29", features = ["full"] }
 tokio-stream = { version = "0.1", features = ["fs"] }
 tokio-util = { version = "0.7", features = ["compat"] }
+toml = { version = "0.7", default-features = false, features = ["parse", "display"] }
 usdt = "0.5.0"
 uuid = { version = "1.16", default-features = false }
 version_check = "0.9.5"

Cargo.toml

@@ -31,3 +31,19 @@ zerocopy.workspace = true
 
 gateway-messages = { workspace = true, features = ["std"] }
 gateway-sp-comms.workspace = true
+
+async-recursion = { workspace = true, optional = true }
+hubtools = { workspace = true, optional = true }
+lpc55_areas = { workspace = true, optional = true }
+lpc55_sign= { workspace = true, optional = true }
+rhai-chrono = { workspace = true, optional = true }
+rhai-env = { workspace = true, optional = true }
+rhai-fs = { workspace = true, optional = true }
+rhai = { workspace = true, optional = true }
+thiserror = { workspace = true, optional = true }
+toml = { workspace = true, optional = true }
+
+[features]
+# XXX remove rhaiscript as a defailt feature
+default = ["rhaiscript"]
+rhaiscript = [ "dep:async-recursion", "dep:hubtools", "dep:lpc55_areas", "dep:lpc55_sign", "dep:rhai", "dep:rhai-chrono", "dep:rhai-env", "dep:rhai-fs", "dep:thiserror", "dep:toml"]

faux-mgs/Cargo.toml

@@ -63,6 +63,8 @@ use uuid::Uuid;
 use zerocopy::AsBytes;
 
 mod picocom_map;
+#[cfg(feature = "rhaiscript")]
+mod rhaiscript;
 mod usart;
 
 /// Command line program that can send MGS messages to a single SP.
@@ -128,6 +130,14 @@ struct Args {
     command: Command,
 }
 
+/// Command line program that can send MGS messages to a single SP.
+#[cfg(feature = "rhaiscript")]
+#[derive(Parser, Debug)]
+struct RhaiArgs {
+    #[clap(subcommand)]
+    command: Command,
+}
+
 fn level_from_str(s: &str) -> Result<Level> {
     if let Ok(level) = s.parse() {
         Ok(level)
@@ -383,6 +393,16 @@ enum Command {
         disable_watchdog: bool,
     },
 
+    /// Run a Rhai script within faux-mgs
+    #[cfg(feature = "rhaiscript")]
+    Rhai {
+        /// Path to Rhia script
+        script: PathBuf,
+        /// Additional arguments passed to Rhia scripe
+        #[clap(trailing_var_arg = true, allow_hyphen_values = true)]
+        script_args: Vec<String>,
+    },
+
     /// Controls the system LED
     SystemLed {
         #[clap(subcommand)]
@@ -826,7 +846,7 @@ async fn main() -> Result<()> {
         .into_iter()
         .map(|sp| {
             let interface = sp.interface().to_string();
-            run_command(
+            run_any_command(
                 sp,
                 args.command.clone(),
                 args.json.is_some(),
@@ -900,11 +920,28 @@ fn ssh_list_keys(socket: &PathBuf) -> Result<Vec<ssh_key::PublicKey>> {
     client.list_identities().context("failed to list identities")
 }
 
-async fn run_command(
+/// This function exists to break recursive calls to the Rhai interpreter.
+/// main() calls here but Rhai{...} calls run_command().
+async fn run_any_command(
     sp: SingleSp,
     command: Command,
     json: bool,
     log: Logger,
+) -> Result<Output> {
+    match command {
+        #[cfg(feature = "rhaiscript")]
+        Command::Rhai { script, script_args } => {
+            rhaiscript::interpreter(&sp, log, script, script_args).await
+        }
+        _ => run_command(&sp, command, json, log).await,
+    }
+}
+
+async fn run_command(
+    sp: &SingleSp,
+    command: Command,
+    json: bool,
+    log: Logger,
 ) -> Result<Output> {
     match command {
         // Skip special commands handled by `main()` above.
@@ -1261,7 +1298,7 @@ async fn run_command(
             let data = fs::read(&image).with_context(|| {
                 format!("failed to read {}", image.display())
             })?;
-            update(&log, &sp, component, slot, data).await.with_context(
+            update(&log, sp, component, slot, data).await.with_context(
                 || {
                     format!(
                         "updating {} slot {} to {} failed",
@@ -1305,7 +1342,7 @@ async fn run_command(
                     ..
                 } => {
                     let id = Uuid::from(id);
-                    format!("update {id} aux flash scan complete (found_match={found_match}")
+                    format!("update {id} aux flash scan complete (found_match={found_match})")
                 }
                 UpdateStatus::InProgress(sub_status) => {
                     let id = Uuid::from(sub_status.id);
@@ -1386,7 +1423,10 @@ async fn run_command(
                 Ok(Output::Lines(vec!["reset complete".to_string()]))
             }
         }
-
+        #[cfg(feature = "rhaiscript")]
+        Command::Rhai { script, script_args } => {
+            rhaiscript::interpreter(sp, log, script, script_args).await
+        }
         Command::ResetComponent { component, disable_watchdog } => {
             sp.reset_component_prepare(component).await?;
             info!(log, "SP is prepared to reset component {component}",);
@@ -1475,14 +1515,8 @@ async fn run_command(
                         if time_sec == 0 {
                             bail!("--time must be >= 1 second");
                         }
-                        monorail_unlock(
-                            &log,
-                            &sp,
-                            time_sec,
-                            ssh_auth_sock,
-                            key,
-                        )
-                        .await?;
+                        monorail_unlock(&log, sp, time_sec, ssh_auth_sock, key)
+                            .await?;
                     }
                 }
             }
@@ -1971,6 +2005,7 @@ async fn populate_phase2_images(
     Ok(())
 }
 
+#[derive(Clone)]
 enum Output {
     Json(serde_json::Value),
     Lines(Vec<String>),