Rewrite Obj-C workflow in Rust

This is functionally equivalent to the previous workflow_objc, with the
following changes:
1. It mutates the `core.function.metaAnalysis` workflow rather than
   registering a new named workflow. The activities now all check for
   the presence of the Objective-C metadata added by `ObjCProcessor` to
   determine whether they should do work, rather than relying on
   `MachoView` to override the function workflow when Objective-C
   metadata is present. This fixes
   https://github.com/Vector35/binaryninja-api/issues/6779.
2. The auto-inlining of `objc_msgSend` selector stub functions is
   performed in a separate activity from the processing of
   `objc_msgSend` call sites. The selector stub inlining activity is
   configured so that it does not run in `DSCView` as the shared cache
   needs different behavior for stub functions more generally that
   `SharedCacheWorkflow` already provides.
3. The way that types like `id` and `SEL` are referenced is fixed so
   that they show up as `id` rather than `objc_struct*`.

This also replaces the Objective-C portion of the shared cache's
workflow, and incorporates several bug fixes that had been applied to it
but not the standalone Objective-C workflow.

1 files changed, 94 insertions, 35 deletions

diff --git a/plugins/workflow_objc/CMakeLists.txt b/plugins/workflow_objc/CMakeLists.txt
index a16a5519..69127ece 100644
--- a/plugins/workflow_objc/CMakeLists.txt
+++ b/plugins/workflow_objc/CMakeLists.txt
@@ -1,47 +1,106 @@
-cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.15 FATAL_ERROR)
 
 project(workflow_objc)
 
-
-if((NOT BN_API_PATH) AND (NOT BN_INTERNAL_BUILD))
-  set(BN_API_PATH $ENV{BN_API_PATH})
-  if(NOT BN_API_PATH)
-    message(FATAL_ERROR "Provide path to Binary Ninja API source in BN_API_PATH")
-  endif()
-endif()
-if(NOT BN_INTERNAL_BUILD)
-  set(HEADLESS ON CACHE BOOL "")
-  add_subdirectory(${BN_API_PATH} ${PROJECT_BINARY_DIR}/api)
+if(NOT BN_API_BUILD_EXAMPLES AND NOT BN_INTERNAL_BUILD)
+    if(NOT BN_API_PATH)
+        # If we have not already defined the API source directory try and find it.
+        find_path(
+                BN_API_PATH
+                NAMES binaryninjaapi.h
+                # List of paths to search for the clone of the api
+                HINTS ../../.. ../../binaryninja/api/ binaryninjaapi binaryninja-api $ENV{BN_API_PATH}
+                REQUIRED
+        )
+    endif()
+    set(CARGO_STABLE_VERSION 1.83.0)
+    add_subdirectory(${BN_API_PATH} binaryninjaapi)
 endif()
 
-# Binary Ninja plugin ----------------------------------------------------------
+file(GLOB_RECURSE PLUGIN_SOURCES CONFIGURE_DEPENDS
+        ${PROJECT_SOURCE_DIR}/Cargo.toml
+        ${PROJECT_SOURCE_DIR}/src/*.rs)
+
+file(GLOB_RECURSE API_SOURCES CONFIGURE_DEPENDS
+        ${PROJECT_SOURCE_DIR}/../../binaryninjacore.h
+        ${PROJECT_SOURCE_DIR}/../../rust/binaryninjacore-sys/build.rs
+        ${PROJECT_SOURCE_DIR}/../../rust/binaryninjacore-sys/Cargo.toml
+        ${PROJECT_SOURCE_DIR}/../../rust/binaryninjacore-sys/src/*.rs
+        ${PROJECT_SOURCE_DIR}/../../rust/Cargo.toml
+        ${PROJECT_SOURCE_DIR}/../../rust/src/*/*.rs)
 
-set(PLUGIN_SOURCE
-  GlobalState.h
-  GlobalState.cpp
-  MessageHandler.cpp
-  MessageHandler.h
-  Plugin.cpp
-  Workflow.h
-  Workflow.cpp)
+if(CMAKE_BUILD_TYPE MATCHES Debug)
+    set(TARGET_DIR ${PROJECT_BINARY_DIR}/target/debug)
+    set(CARGO_OPTS --target-dir=${PROJECT_BINARY_DIR}/target)
+else()
+    set(TARGET_DIR ${PROJECT_BINARY_DIR}/target/release)
+    set(CARGO_OPTS --target-dir=${PROJECT_BINARY_DIR}/target --release)
+    set(OUTPUT_PDB_NAME ${CMAKE_SHARED_LIBRARY_PREFIX}workflow_objc.pdb)
+endif()
 
-add_library(workflow_objc SHARED ${PLUGIN_SOURCE})
-target_link_libraries(workflow_objc binaryninjaapi)
-target_compile_features(workflow_objc PRIVATE cxx_std_20 c_std_99)
-plugin_rpath(workflow_objc)
+set(OUTPUT_FILE ${CMAKE_STATIC_LIBRARY_PREFIX}workflow_objc${CMAKE_SHARED_LIBRARY_SUFFIX})
+set(PLUGIN_PATH ${TARGET_DIR}/${OUTPUT_FILE})
 
-# Library targets linking against the Binary Ninja API need to be compiled with
-# position-independent code on Linux.
-if(${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
-  target_compile_options(workflow_objc PRIVATE "-fPIC")
+add_custom_target(workflow_objc ALL DEPENDS ${PLUGIN_PATH})
+add_dependencies(workflow_objc binaryninjaapi)
+
+find_program(RUSTUP_PATH rustup REQUIRED HINTS ~/.cargo/bin)
+if(CARGO_API_VERSION)
+    set(RUSTUP_COMMAND ${RUSTUP_PATH} run ${CARGO_API_VERSION} cargo build)
+else()
+    set(RUSTUP_COMMAND ${RUSTUP_PATH} run ${CARGO_STABLE_VERSION} cargo build)
 endif()
 
-# Configure plugin output directory for internal builds, otherwise configure
-# plugin installation for public builds.
-if(BN_INTERNAL_BUILD)
-  set_target_properties(workflow_objc PROPERTIES
-    LIBRARY_OUTPUT_DIRECTORY ${BN_CORE_PLUGIN_DIR}
-    RUNTIME_OUTPUT_DIRECTORY ${BN_CORE_PLUGIN_DIR})
+if(APPLE)
+    if(UNIVERSAL)
+        if(CMAKE_BUILD_TYPE MATCHES Debug)
+            set(AARCH64_LIB_PATH ${PROJECT_BINARY_DIR}/target/aarch64-apple-darwin/debug/${OUTPUT_FILE})
+            set(X86_64_LIB_PATH ${PROJECT_BINARY_DIR}/target/x86_64-apple-darwin/debug/${OUTPUT_FILE})
+        else()
+            set(AARCH64_LIB_PATH ${PROJECT_BINARY_DIR}/target/aarch64-apple-darwin/release/${OUTPUT_FILE})
+            set(X86_64_LIB_PATH ${PROJECT_BINARY_DIR}/target/x86_64-apple-darwin/release/${OUTPUT_FILE})
+        endif()
+
+        add_custom_command(
+                OUTPUT ${PLUGIN_PATH}
+                COMMAND ${CMAKE_COMMAND} -E env
+                MACOSX_DEPLOYMENT_TARGET=10.14 BINARYNINJADIR=${BN_CORE_OUTPUT_DIR}
+                ${RUSTUP_COMMAND} --target=aarch64-apple-darwin ${CARGO_OPTS}
+                COMMAND ${CMAKE_COMMAND} -E env
+                MACOSX_DEPLOYMENT_TARGET=10.14 BINARYNINJADIR=${BN_CORE_OUTPUT_DIR}
+                ${RUSTUP_COMMAND} --target=x86_64-apple-darwin ${CARGO_OPTS}
+                COMMAND mkdir -p ${TARGET_DIR}
+                COMMAND lipo -create ${AARCH64_LIB_PATH} ${X86_64_LIB_PATH} -output ${PLUGIN_PATH}
+                COMMAND ${CMAKE_COMMAND} -E copy ${PLUGIN_PATH} ${BN_CORE_PLUGIN_DIR}
+                WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+                DEPENDS ${PLUGIN_SOURCES} ${API_SOURCES})
+    else()
+        if(CMAKE_BUILD_TYPE MATCHES Debug)
+            set(LIB_PATH ${PROJECT_BINARY_DIR}/target/debug/${OUTPUT_FILE})
+        else()
+            set(LIB_PATH ${PROJECT_BINARY_DIR}/target/release/${OUTPUT_FILE})
+        endif()
+
+        add_custom_command(
+                OUTPUT ${PLUGIN_PATH}
+                COMMAND ${CMAKE_COMMAND} -E env MACOSX_DEPLOYMENT_TARGET=10.14 BINARYNINJADIR=${BN_CORE_OUTPUT_DIR} ${RUSTUP_COMMAND} ${CARGO_OPTS}
+                COMMAND ${CMAKE_COMMAND} -E copy ${PLUGIN_PATH} ${BN_CORE_PLUGIN_DIR}
+                WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+                DEPENDS ${PLUGIN_SOURCES} ${API_SOURCES})
+    endif()
+elseif(WIN32)
+    add_custom_command(
+            OUTPUT ${PLUGIN_PATH}
+            COMMAND ${CMAKE_COMMAND} -E env BINARYNINJADIR=${BN_CORE_OUTPUT_DIR} ${RUSTUP_COMMAND} ${CARGO_OPTS}
+            COMMAND ${CMAKE_COMMAND} -E copy ${PLUGIN_PATH} ${BN_CORE_PLUGIN_DIR}
+            COMMAND ${CMAKE_COMMAND} -E copy ${TARGET_DIR}/${OUTPUT_PDB_NAME} ${BN_CORE_PLUGIN_DIR}
+            WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+            DEPENDS ${PLUGIN_SOURCES} ${API_SOURCES})
 else()
-  bn_install_plugin(workflow_objc)
+    add_custom_command(
+            OUTPUT ${PLUGIN_PATH}
+            COMMAND ${CMAKE_COMMAND} -E env BINARYNINJADIR=${BN_CORE_OUTPUT_DIR} ${RUSTUP_COMMAND} ${CARGO_OPTS}
+            COMMAND ${CMAKE_COMMAND} -E copy ${PLUGIN_PATH} ${BN_CORE_PLUGIN_DIR}
+            WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+            DEPENDS ${PLUGIN_SOURCES} ${API_SOURCES})
 endif()