Add option to build rust api without linking to core

Author: negasora

Cargo.lock

@@ -7,16 +7,20 @@ rust-version = "1.83.0"
 license = "Apache-2.0"
 
 [features]
+default = ["core"]
 # This is used when statically linking to prevent exporting CorePluginABIVersion and UiPluginABIVersion.
 no_exports = []
 # Add this if you want to support the demo version of the product.
 # This will disable certain functions that do not exist in the demo build.
 demo = ["no_exports"]
+# If disabled, a stubbed binaryninjacore library will be generated and linked.
+# This feature should only be disabled for shared libraries that will later be loaded in the same process as the real binaryninjacore.
+core = ["binaryninjacore-sys/core"]
 
 [dependencies]
 log = { version = "0.4", features = ["std"] }
 rayon = { version = "1.10", optional = true }
-binaryninjacore-sys = { path = "binaryninjacore-sys" }
+binaryninjacore-sys = { path = "binaryninjacore-sys", default-features = false}
 thiserror = "2.0"
 serde = "1.0"
 serde_derive = "1.0"

rust/Cargo.toml

@@ -7,8 +7,15 @@ edition = "2021"
 links = "binaryninjacore"
 license = "Apache-2.0"
 
+[features]
+default = ["core"]
+# If disabled, a stubbed binaryninjacore library will be generated and linked.
+# This feature should only be disabled for shared libraries that will later be loaded in the same process as the real binaryninjacore.
+core = []
+
 [build-dependencies]
 bindgen = "0.71.1"
 # TODO: Remove this once bindgen correctly pins the version.
 # proc-macro2 v1.0.79 does not have https://docs.rs/proc-macro2/1.0.80/proc_macro2/struct.Literal.html#method.c_string
-proc-macro2 = ">=1.0.80"
+proc-macro2 = ">=1.0.80"
+cc = "1.2.31"

rust/binaryninjacore-sys/Cargo.toml

@@ -3,6 +3,7 @@ use std::fs::File;
 use std::io::BufRead;
 use std::io::BufReader;
 use std::path::PathBuf;
+use std::process::Command;
 
 #[cfg(target_os = "macos")]
 static LASTRUN_PATH: (&str, &str) = ("HOME", "Library/Application Support/Binary Ninja/lastrun");
@@ -41,16 +42,59 @@ fn link_path() -> PathBuf {
         })
 }
 
+fn generate_stubs() -> PathBuf {
+    // Generate and compile stub shared library and return the path
+
+    let out_dir = PathBuf::from(env::var("OUT_DIR").unwrap());
+
+    let manifest_dir = std::env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR not set");
+
+    // To construct paths relative to the manifest directory:
+    let api_base_path = std::path::PathBuf::from(manifest_dir)
+        .join("../../")
+        .canonicalize()
+        .unwrap();
+
+    let generate_stubs_path = api_base_path.join("cmake").join("generate_stubs.py");
+    let binaryninja_core_header_path = api_base_path.join("binaryninjacore.h");
+    let stubs_path = out_dir.join("stubs");
+
+    let generate_status = Command::new("python")
+        .args(&[
+            generate_stubs_path.to_str().unwrap(),
+            binaryninja_core_header_path.to_str().unwrap(),
+            stubs_path.to_str().unwrap(),
+        ])
+        .status()
+        .expect("Failed to generate stubs");
+
+    if !generate_status.success() {
+        panic!("Failed to generate stubs");
+    }
+
+    cc::Build::new()
+        .file(stubs_path.join("stubs.cpp")) // This is named .cpp but is actually c
+        .shared_flag(true)
+        .include(api_base_path)
+        .warnings(false)
+        .compile("binaryninjacore");
+
+    out_dir
+}
+
 fn main() {
     println!("cargo:rerun-if-env-changed=BINARYNINJADIR");
     println!("cargo:rerun-if-changed=../../binaryninjacore.h");
 
     //Cargo's output directory
     let out_dir = env::var("OUT_DIR").unwrap();
 
-    let link_path = env::var("BINARYNINJADIR")
-        .map(PathBuf::from)
-        .unwrap_or_else(|_| link_path());
+    let link_path = match env::var("CARGO_FEATURE_CORE") {
+        Ok(_) => env::var("BINARYNINJADIR")
+            .map(PathBuf::from)
+            .unwrap_or_else(|_| link_path()),
+        Err(_) => generate_stubs(),
+    };
 
     // Linux builds of binaryninja ship with libbinaryninjacore.so.1 in the
     // application folder and no symlink. The linker will attempt to link with

rust/binaryninjacore-sys/build.rs

@@ -1,8 +1,8 @@
 use std::path::PathBuf;
 
 fn main() {
-    let link_path =
-        std::env::var_os("DEP_BINARYNINJACORE_PATH").expect("DEP_BINARYNINJACORE_PATH specified");
+    let link_path = std::env::var_os("DEP_BINARYNINJACORE_PATH")
+        .expect("DEP_BINARYNINJACORE_PATH not specified");
 
     println!("cargo::rustc-link-lib=dylib=binaryninjacore");
     println!("cargo::rustc-link-search={}", link_path.to_str().unwrap());
@@ -15,7 +15,7 @@ fn main() {
         );
     }
 
-    let out_dir = std::env::var("OUT_DIR").expect("OUT_DIR specified");
+    let out_dir = std::env::var("OUT_DIR").expect("OUT_DIR not specified");
     let out_dir_path = PathBuf::from(out_dir);
 
     // Copy all binaries to OUT_DIR for unit tests.