Add option to build rust api without linking to core

Author: negasora

CMakeLists.txt

@@ -39,33 +39,22 @@ if(BinaryNinjaCore_FOUND)
     target_link_directories(binaryninjaapi PUBLIC ${BinaryNinjaCore_LIBRARY_DIRS})
     target_compile_definitions(binaryninjaapi PUBLIC ${BinaryNinjaCore_DEFINITIONS})
 else()
+    add_subdirectory(stubs EXCLUDE_FROM_ALL)
+
+    # Be sure to only link against the stubs archive file
+    add_dependencies(binaryninjaapi binaryninjacore_stubs)
+
     if(APPLE)
-        target_link_options(binaryninjaapi PUBLIC -undefined dynamic_lookup)
+        target_link_libraries(binaryninjaapi PUBLIC "$<TARGET_PROPERTY:binaryninjacore_stubs,ARCHIVE_OUTPUT_DIRECTORY>/$<TARGET_PROPERTY:binaryninjacore_stubs,OUTPUT_NAME>.dylib")
     elseif(MSVC)
-        # Generate stubs.cpp with implementations of all the BNAPI functions
-        execute_process(COMMAND python ${PROJECT_SOURCE_DIR}/cmake/generate_stubs.py ${PROJECT_SOURCE_DIR}/binaryninjacore.h ${PROJECT_BINARY_DIR}/stubs)
-        
-        # Compile those stubs into a stub library we can use to fool the linker
-        add_library(binaryninjacore SHARED ${PROJECT_BINARY_DIR}/stubs/stubs.cpp)
-        set_target_properties(binaryninjacore
-            PROPERTIES OUTPUT_NAME binaryninjacore
-            SOVERSION 1
-            ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/stubs
-            LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/stubs
-            RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/stubs
-        )
-        target_include_directories(binaryninjacore PUBLIC ${PROJECT_SOURCE_DIR})
-        
-        # Be sure to only link against the stubs archive file
-        add_dependencies(binaryninjaapi binaryninjacore)
         if(${CMAKE_GENERATOR} MATCHES "^Visual Studio")
             # Visual Studio's generator adds the config to the file path
-            target_link_libraries(binaryninjaapi PUBLIC "$<TARGET_PROPERTY:binaryninjacore,ARCHIVE_OUTPUT_DIRECTORY>/$<CONFIG>/$<TARGET_PROPERTY:binaryninjacore,OUTPUT_NAME>.lib")
+            target_link_libraries(binaryninjaapi PUBLIC "$<TARGET_PROPERTY:binaryninjacore_stubs,ARCHIVE_OUTPUT_DIRECTORY>/$<CONFIG>/$<TARGET_PROPERTY:binaryninjacore_stubs,OUTPUT_NAME>.lib")
         else()
-            target_link_libraries(binaryninjaapi PUBLIC "$<TARGET_PROPERTY:binaryninjacore,ARCHIVE_OUTPUT_DIRECTORY>/$<TARGET_PROPERTY:binaryninjacore,OUTPUT_NAME>.lib")
+            target_link_libraries(binaryninjaapi PUBLIC "$<TARGET_PROPERTY:binaryninjacore_stubs,ARCHIVE_OUTPUT_DIRECTORY>/$<TARGET_PROPERTY:binaryninjacore_stubs,OUTPUT_NAME>.lib")
         endif()
     else()
-        target_link_options(binaryninjaapi PUBLIC "LINKER:--allow-shlib-undefined")
+        target_link_libraries(binaryninjaapi PUBLIC "$<TARGET_PROPERTY:binaryninjacore_stubs,ARCHIVE_OUTPUT_DIRECTORY>/$<TARGET_PROPERTY:binaryninjacore_stubs,OUTPUT_NAME>.so.1")
     endif()
 endif()
 

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"
+cmake = "0.1"

rust/binaryninjacore-sys/Cargo.toml

@@ -41,16 +41,32 @@ fn link_path() -> PathBuf {
         })
 }
 
+// Generate and compile stub shared library and return the path to the folder containing the built stub library
+fn generate_stubs() -> PathBuf {
+    let manifest_dir = std::env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR not set");
+
+    let api_base_path = std::path::PathBuf::from(manifest_dir)
+        .join("../../")
+        .canonicalize()
+        .unwrap();
+
+    let stubs_path = api_base_path.join("stubs");
+    cmake::build(stubs_path).join("build")
+}
+
 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.

rust/build.rs

@@ -0,0 +1,18 @@
+cmake_minimum_required(VERSION 3.15 FATAL_ERROR)
+project(binaryninjacore_stubs)
+
+
+# Generate stubs.cpp with implementations of all the BNAPI functions
+execute_process(COMMAND python ${PROJECT_SOURCE_DIR}/generate_stubs.py ${PROJECT_SOURCE_DIR}/../binaryninjacore.h ${PROJECT_BINARY_DIR})
+
+# Compile those stubs into a stub library we can use to fool the linker
+add_library(binaryninjacore_stubs SHARED ${PROJECT_BINARY_DIR}/stubs.cpp)
+
+set_target_properties(binaryninjacore_stubs
+    PROPERTIES OUTPUT_NAME binaryninjacore
+    SOVERSION 1
+)
+
+target_include_directories(binaryninjacore_stubs PUBLIC ${PROJECT_SOURCE_DIR}/..)
+
+install(TARGETS binaryninjacore_stubs LIBRARY DESTINATION ${PROJECT_BINARY_DIR})