Improve initialization in rust headless scripts

Provide sensible errors and validation to rust headless scripts, solves #5796

Author: emesare

plugins/pdb-ng/src/lib.rs

@@ -91,20 +91,13 @@ fn active_local_cache(view: Option<&BinaryView>) -> Result<String> {
         .get_string("pdb.files.localStoreAbsolute", view, None)
         .to_string();
     if local_store_path.is_empty() {
-        local_store_path = match user_directory() {
-            Ok(mut dir) => {
-                dir.push(
-                    Settings::new("")
-                        .get_string("pdb.files.localStoreRelative", view, None)
-                        .to_string(),
-                );
-                match dir.to_str() {
-                    Some(s) => s.to_string(),
-                    _ => "".to_string(),
-                }
-            }
-            _ => "".to_string(),
-        };
+        let relative_local_store = Settings::new("")
+            .get_string("pdb.files.localStoreRelative", view, None)
+            .to_string();
+        local_store_path = user_directory()
+            .join(relative_local_store)
+            .to_string_lossy()
+            .to_string();
     }
     if !local_store_path.is_empty() {
         Ok(local_store_path)

plugins/warp/benches/convert.rs

@@ -5,7 +5,7 @@ use std::path::PathBuf;
 use warp_ninja::convert::from_bn_type;
 
 pub fn type_conversion_benchmark(c: &mut Criterion) {
-    let session = Session::new();
+    let session = Session::new().expect("Failed to initialize session");
     let out_dir = env!("OUT_DIR").parse::<PathBuf>().unwrap();
     for entry in std::fs::read_dir(out_dir).expect("Failed to read OUT_DIR") {
         let entry = entry.expect("Failed to read directory entry");

plugins/warp/benches/function.rs

@@ -6,7 +6,7 @@ use warp_ninja::build_function;
 use warp_ninja::cache::FunctionCache;
 
 pub fn function_benchmark(c: &mut Criterion) {
-    let session = Session::new();
+    let session = Session::new().expect("Failed to initialize session");
     let bv = session.load(env!("TEST_BIN_LIBRARY_OBJ")).unwrap();
     let functions = bv.functions();
     assert_eq!(functions.len(), 6);

plugins/warp/benches/guid.rs

@@ -4,7 +4,7 @@ use criterion::{criterion_group, criterion_main, Criterion};
 use warp_ninja::function_guid;
 
 pub fn guid_benchmark(c: &mut Criterion) {
-    let session = Session::new();
+    let session = Session::new().expect("Failed to initialize session");
     let bv = session.load(env!("TEST_BIN_LIBRARY_OBJ")).unwrap();
     let functions = bv.functions();
     assert_eq!(functions.len(), 6);

plugins/warp/src/bin/sigem.rs

@@ -92,7 +92,8 @@ fn main() {
     }
 
     log::debug!("Starting Binary Ninja session...");
-    let _headless_session = binaryninja::headless::Session::new();
+    let _headless_session =
+        binaryninja::headless::Session::new().expect("Failed to initialize session");
 
     // Adjust the amount of worker threads so that we can actually free BinaryViews.
     let bn_settings = Settings::new("");
@@ -258,7 +259,8 @@ mod tests {
         env_logger::init();
         // TODO: Store oracles here to get more out of this test.
         let out_dir = env!("OUT_DIR").parse::<PathBuf>().unwrap();
-        let _headless_session = binaryninja::headless::Session::new();
+        let _headless_session =
+            binaryninja::headless::Session::new().expect("Failed to initialize session");
         let bn_settings = Settings::new("");
         let settings = default_settings(&bn_settings);
         for entry in std::fs::read_dir(out_dir).expect("Failed to read OUT_DIR") {

plugins/warp/src/convert.rs

@@ -582,7 +582,7 @@ mod tests {
     static INIT: OnceLock<Session> = OnceLock::new();
 
     fn get_session<'a>() -> &'a Session {
-        INIT.get_or_init(|| Session::new())
+        INIT.get_or_init(|| Session::new().expect("Failed to initialize session"))
     }
 
     #[test]

plugins/warp/src/lib.rs

@@ -28,7 +28,7 @@ mod plugin;
 
 pub fn core_signature_dir() -> PathBuf {
     // Get core signatures for the given platform
-    let install_dir = binaryninja::install_directory().unwrap();
+    let install_dir = binaryninja::install_directory();
     // macOS core dir is separate from the install dir.
     #[cfg(target_os = "macos")]
     let core_dir = install_dir.parent().unwrap().join("Resources");
@@ -38,7 +38,7 @@ pub fn core_signature_dir() -> PathBuf {
 }
 
 pub fn user_signature_dir() -> PathBuf {
-    binaryninja::user_directory().unwrap().join("signatures/")
+    binaryninja::user_directory().join("signatures/")
 }
 
 pub fn build_function<A: Architecture, M: FunctionMutability, V: NonSSAVariant>(
@@ -185,7 +185,7 @@ mod tests {
 
     fn get_session<'a>() -> &'a Session {
         // TODO: This is not shared between other test modules, should still be fine (mutex in core now).
-        INIT.get_or_init(|| Session::new())
+        INIT.get_or_init(|| Session::new().expect("Failed to initialize session"))
     }
 
     #[test]

rust/Cargo.toml

@@ -14,6 +14,7 @@ no_exports = []
 log = { version = "0.4", features = ["std"] }
 rayon = { version = "1.8", optional = true }
 binaryninjacore-sys = { path = "binaryninjacore-sys" }
+thiserror = "2.0"
 
 [dev-dependencies]
 rstest = "0.24.0"

rust/examples/decompile.rs

@@ -31,7 +31,8 @@ pub fn main() {
 
     println!("Starting session...");
     // This loads all the core architecture, platform, etc plugins
-    let headless_session = binaryninja::headless::Session::new();
+    let headless_session =
+        binaryninja::headless::Session::new().expect("Failed to initialize session");
 
     println!("Loading binary...");
     let bv = headless_session

rust/examples/demangler.rs

@@ -28,7 +28,8 @@ impl CustomDemangler for TestDemangler {
 fn main() {
     println!("Starting session...");
     // This loads all the core architecture, platform, etc plugins
-    let _headless_session = binaryninja::headless::Session::new();
+    let _headless_session =
+        binaryninja::headless::Session::new().expect("Failed to initialize session");
 
     println!("Registering demangler...");
     Demangler::register("Test", TestDemangler);