Add support for declarative downstream dependencies to workflow system.

Author: bpotchik

binaryninjacore.h

@@ -37,7 +37,7 @@
 // Current ABI version for linking to the core. This is incremented any time
 // there are changes to the API that affect linking, including new functions,
 // new types, or modifications to existing functions or types.
-#define BN_CURRENT_CORE_ABI_VERSION 126
+#define BN_CURRENT_CORE_ABI_VERSION 127
 
 // Minimum ABI version that is supported for loading of plugins. Plugins that
 // are linked to an ABI version less than this will not be able to load and
@@ -2731,12 +2731,13 @@ extern "C"
 
 	typedef enum BNAnalysisState
 	{
-		InitialState,
-		HoldState,
-		IdleState,
-		DisassembleState,
-		AnalyzeState,
-		ExtendedAnalyzeState
+		InitialState,        // Entry point before any analysis begins
+		HoldState,           // Module-level analysis is deferred; On-demand function analysis is permitted
+		IdleState,           // No active analysis; system is idle and ready
+		DiscoveryState,      // Context gathering and auxiliary data preparation
+		DisassembleState,    // Instruction decoding and control flow discovery
+		AnalyzeState,        // Core semantic and structural analysis
+		ExtendedAnalyzeState // Supplemental analysis: sweeping, type resolution, and pattern matching
 	} BNAnalysisState;
 
 	typedef struct BNActiveAnalysisInfo

plugins/efi_resolver/src/Plugin.cpp

@@ -70,6 +70,9 @@ extern "C"
 			"eligibility": {
 				"runOnce": true,
 				"auto": {}
+			},
+			"dependencies": {
+				"downstream": ["core.module.update"]
 			}
 		})~", &RunWorkflow);
 

plugins/rtti/plugin.cpp

@@ -115,13 +115,16 @@ extern "C" {
 			"eligibility": {
 				"runOnce": true,
 				"auto": {}
+			},
+			"dependencies": {
+				"downstream": ["core.module.update"]
 			}
-		})~", &VFTAnalysis, {"core.module.update"});
+		})~", &VFTAnalysis);
 
 		// Run rtti before debug info is applied.
 		rttiMetaWorkflow->Insert("core.module.loadDebugInfo", "analysis.rtti.rttiAnalysis");
 		// Run vft after functions have analyzed (so that the virtual functions have analyzed)
-		rttiMetaWorkflow->Insert("core.module.deleteUnusedAutoFunctions", "analysis.rtti.vftAnalysis");
+		rttiMetaWorkflow->InsertAfter("core.module.extendedAnalysis", "analysis.rtti.vftAnalysis");
 		Workflow::RegisterWorkflow(rttiMetaWorkflow);
 
 		return true;

plugins/warp/src/plugin/workflow.rs

@@ -40,6 +40,9 @@ const MATCHER_ACTIVITY_CONFIG: &str = r#"{
     "eligibility": {
         "auto": {},
         "runOnce": true
+    },
+    "dependencies": {
+        "downstream": ["core.module.update"]
     }
 }"#;
 
@@ -288,10 +291,10 @@ pub fn insert_workflow() {
     let matcher_activity = Activity::new_with_action(MATCHER_ACTIVITY_CONFIG, matcher_activity);
     // Matcher activity must have core.module.update as subactivity otherwise analysis will sometimes never retrigger.
     module_meta_workflow
-        .register_activity_with_subactivities(&matcher_activity, vec!["core.module.update"])
+        .register_activity(&matcher_activity)
         .unwrap();
     module_meta_workflow.insert(
-        "core.module.deleteUnusedAutoFunctions",
+        "core.module.finishUpdate",
         [MATCHER_ACTIVITY_NAME],
     );
     module_meta_workflow.register().unwrap();

python/binaryview.py

@@ -656,6 +656,8 @@ def __str__(self):
 			return "Hold"
 		if self.state == AnalysisState.IdleState:
 			return "Idle"
+		if self.state == AnalysisState.DiscoveryState:
+			return "Discovery"
 		if self.state == AnalysisState.DisassembleState:
 			return "Disassembling (%d/%d)" % (self.count, self.total)
 		if self.state == AnalysisState.AnalyzeState: