[WARP] Use type-safe activity configuration

Author: bdash

plugins/warp/src/plugin/workflow.rs

@@ -11,6 +11,7 @@ use binaryninja::background_task::BackgroundTask;
 use binaryninja::binary_view::{BinaryView, BinaryViewExt};
 use binaryninja::command::Command;
 use binaryninja::settings::{QueryOptions, Settings};
+use binaryninja::workflow::activity::{Config, Eligibility};
 use binaryninja::workflow::{Activity, AnalysisContext, Workflow};
 use itertools::Itertools;
 use std::collections::HashMap;
@@ -19,41 +20,7 @@ use warp::r#type::class::function::{Location, RegisterLocation, StackLocation};
 use warp::signature::function::{Function, FunctionGUID};
 use warp::target::Target;
 
-pub const APPLY_ACTIVITY_NAME: &str = "analysis.warp.apply";
-const APPLY_ACTIVITY_CONFIG: &str = r#"{
-    "name": "analysis.warp.apply",
-    "title" : "WARP Apply Matched",
-    "description": "This analysis step applies WARP info to matched functions...",
-    "eligibility": {
-        "auto": {},
-        "runOnce": false
-    }
-}"#;
-
-pub const MATCHER_ACTIVITY_NAME: &str = "analysis.warp.matcher";
-const MATCHER_ACTIVITY_CONFIG: &str = r#"{
-    "name": "analysis.warp.matcher",
-    "title" : "WARP Matcher",
-    "description": "This analysis step attempts to find matching WARP functions after the initial analysis is complete...",
-    "eligibility": {
-        "auto": {},
-        "runOnce": true
-    },
-    "dependencies": {
-        "downstream": ["core.module.update"]
-    }
-}"#;
-
 pub const GUID_ACTIVITY_NAME: &str = "analysis.warp.guid";
-const GUID_ACTIVITY_CONFIG: &str = r#"{
-    "name": "analysis.warp.guid",
-    "title" : "WARP GUID Generator",
-    "description": "This analysis step generates the GUID for all analyzed functions...",
-    "eligibility": {
-        "auto": {},
-        "runOnce": false
-    }
-}"#;
 
 pub struct RunMatcher;
 
@@ -259,29 +226,47 @@ pub fn insert_workflow() {
         }
     };
 
-    let guid_activity = Activity::new_with_action(GUID_ACTIVITY_CONFIG, guid_activity);
-    let apply_activity = Activity::new_with_action(APPLY_ACTIVITY_CONFIG, apply_activity);
+    let guid_config = Config::action(
+        GUID_ACTIVITY_NAME,
+        "WARP GUID Generator",
+        "This analysis step generates the GUID for all analyzed functions...",
+    )
+    .eligibility(Eligibility::auto().run_once(false));
+    let guid_activity = Activity::new_with_action(&guid_config, guid_activity);
+
+    let apply_config = Config::action(
+        "analysis.warp.apply",
+        "WARP Apply Matched",
+        "This analysis step applies WARP info to matched functions...",
+    )
+    .eligibility(Eligibility::auto().run_once(false));
+    let apply_activity = Activity::new_with_action(&apply_config, apply_activity);
 
     let add_function_activities = |workflow: &Workflow| {
-        let new_workflow = workflow.clone_to(&workflow.name());
-        new_workflow.register_activity(&guid_activity).unwrap();
-        new_workflow.register_activity(&apply_activity).unwrap();
-        new_workflow.insert_after("core.function.runFunctionRecognizers", [GUID_ACTIVITY_NAME]);
-        new_workflow.insert_after("core.function.generateMediumLevelIL", [APPLY_ACTIVITY_NAME]);
-        new_workflow.register().unwrap();
+        workflow.register_activity(&guid_activity).unwrap();
+        workflow.register_activity(&apply_activity).unwrap();
+        workflow.insert_after("core.function.runFunctionRecognizers", [&guid_config.name]);
+        workflow.insert_after("core.function.generateMediumLevelIL", [&apply_config.name]);
+        workflow.register().unwrap();
     };
 
-    add_function_activities(&Workflow::instance("core.function.metaAnalysis"));
+    add_function_activities(&Workflow::cloned("core.function.metaAnalysis"));
     // TODO: Remove this once the objectivec workflow is registered on the meta workflow.
-    add_function_activities(&Workflow::instance("core.function.objectiveC"));
+    add_function_activities(&Workflow::cloned("core.function.objectiveC"));
 
-    let old_module_meta_workflow = Workflow::instance("core.module.metaAnalysis");
-    let module_meta_workflow = old_module_meta_workflow.clone_to("core.module.metaAnalysis");
-    let matcher_activity = Activity::new_with_action(MATCHER_ACTIVITY_CONFIG, matcher_activity);
+    let module_meta_workflow = Workflow::cloned("core.module.metaAnalysis");
+    let matcher_config = Config::action(
+        "analysis.warp.matcher",
+        "WARP Matcher",
+        "This analysis step attempts to find matching WARP functions after the initial analysis is complete...",
+    )
+    .eligibility(Eligibility::auto().run_once(true))
+    .downstream_dependencies(["core.module.update"]);
+    let matcher_activity = Activity::new_with_action(&matcher_config, matcher_activity);
     // Matcher activity must have core.module.update as subactivity otherwise analysis will sometimes never retrigger.
     module_meta_workflow
         .register_activity(&matcher_activity)
         .unwrap();
-    module_meta_workflow.insert("core.module.finishUpdate", [MATCHER_ACTIVITY_NAME]);
+    module_meta_workflow.insert("core.module.finishUpdate", [&matcher_config.name]);
     module_meta_workflow.register().unwrap();
 }