More rust cleanup

- Normalized modules
- Split some code out into own files
- Fixed some UB in type archive and projects
- Improved API around type archives and projects substantially
- Added ProgressExecutor abstraction for functions which have a progress callback
- Improved background task documentation and added unit tests
- Added worker thread api and unit tests
- Moved some owned types to ref types, this is still not complete, but this is the path forward.
- Add external location/library accessors to the binary view
- Added some misc documentation
- Replaced mod.rs with the module name source file

Still need to normalize some paths and also update some documentation surrounding that change.

Author: emesare

arch/msp430/src/architecture.rs

@@ -19,8 +19,8 @@ use msp430_asm::{
 use binaryninja::architecture::{
     BranchKind, FlagClassId, FlagGroupId, FlagId, FlagWriteId, RegisterId,
 };
-use binaryninja::lowlevelil::expression::ValueExpr;
-use binaryninja::lowlevelil::{MutableLiftedILExpr, MutableLiftedILFunction};
+use binaryninja::low_level_il::expression::ValueExpr;
+use binaryninja::low_level_il::{MutableLiftedILExpr, MutableLiftedILFunction};
 use log::error;
 
 const MIN_MNEMONIC: usize = 9;

arch/msp430/src/lib.rs

@@ -5,8 +5,8 @@ extern crate msp430_asm;
 use binaryninja::{
     add_optional_plugin_dependency,
     architecture::ArchitectureExt,
-    callingconvention,
-    custombinaryview::{BinaryViewType, BinaryViewTypeExt},
+    calling_convention,
+    custom_binary_view::{BinaryViewType, BinaryViewTypeExt},
     Endianness,
 };
 use log::LevelFilter;
@@ -36,13 +36,13 @@ pub extern "C" fn CorePluginInit() -> bool {
     // https://www.ti.com/lit/an/slaa664/slaa664.pdf?ts=1613210655081. MSPGCC
     // appears to be a legacy calling convention while EABI is the newer
     // standardized one that is compatible with TI's compiler
-    let default = callingconvention::ConventionBuilder::new(arch)
+    let default = calling_convention::ConventionBuilder::new(arch)
         .is_eligible_for_heuristics(true)
         .int_arg_registers(&["r15", "r14", "r13", "r12"])
         .return_int_reg("r15")
         .return_hi_int_reg("r14")
         .register("default");
-    callingconvention::ConventionBuilder::new(arch)
+    calling_convention::ConventionBuilder::new(arch)
         .is_eligible_for_heuristics(true)
         .return_int_reg("r15")
         .return_hi_int_reg("r14")

arch/msp430/src/lift.rs

@@ -3,7 +3,7 @@ use crate::flag::{Flag, FlagWrite};
 use crate::register::Register;
 use crate::Msp430;
 
-use binaryninja::{architecture::FlagCondition, lowlevelil::lifting::Label};
+use binaryninja::{architecture::FlagCondition, low_level_il::lifting::Label};
 
 use msp430_asm::emulate::Emulated;
 use msp430_asm::instruction::Instruction;
@@ -12,8 +12,8 @@ use msp430_asm::operand::{Operand, OperandWidth};
 use msp430_asm::single_operand::SingleOperand;
 use msp430_asm::two_operand::TwoOperand;
 
-use binaryninja::lowlevelil::expression::ValueExpr;
-use binaryninja::lowlevelil::{MutableLiftedILExpr, MutableLiftedILFunction};
+use binaryninja::low_level_il::expression::ValueExpr;
+use binaryninja::low_level_il::{MutableLiftedILExpr, MutableLiftedILFunction};
 use log::info;
 
 macro_rules! auto_increment {

arch/msp430/src/register.rs

@@ -1,7 +1,7 @@
 use binaryninja::architecture;
 use binaryninja::architecture::{ImplicitRegisterExtend, RegisterId};
 
-use binaryninja::lowlevelil::LowLevelILRegister;
+use binaryninja::low_level_il::LowLevelILRegister;
 use std::borrow::Cow;
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]

arch/riscv/src/lib.rs

@@ -14,12 +14,12 @@ use binaryninja::{
         LlvmServicesRelocMode, Register as Reg, RegisterInfo, UnusedFlag, UnusedRegisterStack,
         UnusedRegisterStackInfo,
     },
-    binaryview::{BinaryView, BinaryViewExt},
-    callingconvention::{register_calling_convention, CallingConventionBase, ConventionBuilder},
-    custombinaryview::{BinaryViewType, BinaryViewTypeExt},
+    binary_view::{BinaryView, BinaryViewExt},
+    calling_convention::{register_calling_convention, CallingConventionBase, ConventionBuilder},
+    custom_binary_view::{BinaryViewType, BinaryViewTypeExt},
     disassembly::{InstructionTextToken, InstructionTextTokenKind},
     function::Function,
-    functionrecognizer::FunctionRecognizer,
+    function_recognizer::FunctionRecognizer,
     rc::Ref,
     relocation::{
         CoreRelocationHandler, CustomRelocationHandlerHandle, RelocationHandler, RelocationInfo,
@@ -37,10 +37,10 @@ use std::marker::PhantomData;
 use binaryninja::architecture::{BranchKind, IntrinsicId, RegisterId};
 use binaryninja::confidence::{Conf, MAX_CONFIDENCE, MIN_CONFIDENCE};
 use binaryninja::logger::Logger;
-use binaryninja::lowlevelil::expression::{LowLevelILExpressionKind, ValueExpr};
-use binaryninja::lowlevelil::instruction::LowLevelILInstructionKind;
-use binaryninja::lowlevelil::lifting::{Label, LiftableLowLevelIL, LiftableLowLevelILWithSize};
-use binaryninja::lowlevelil::{
+use binaryninja::low_level_il::expression::{LowLevelILExpressionKind, ValueExpr};
+use binaryninja::low_level_il::instruction::LowLevelILInstructionKind;
+use binaryninja::low_level_il::lifting::{Label, LiftableLowLevelIL, LiftableLowLevelILWithSize};
+use binaryninja::low_level_il::{
     expression::ExpressionHandler, instruction::InstructionHandler, LowLevelILRegister,
     MutableLiftedILExpr, MutableLiftedILFunction, RegularLowLevelILFunction,
 };

plugins/dwarf/dwarf_export/src/lib.rs

@@ -12,7 +12,7 @@ use std::fs;
 
 use binaryninja::logger::Logger;
 use binaryninja::{
-    binaryview::{BinaryView, BinaryViewBase, BinaryViewExt},
+    binary_view::{BinaryView, BinaryViewBase, BinaryViewExt},
     command::{register, Command},
     confidence::Conf,
     interaction,

plugins/dwarf/dwarf_import/src/dwarfdebuginfo.rs

@@ -18,12 +18,12 @@ use crate::{
 };
 
 use binaryninja::{
-    binaryview::{BinaryView, BinaryViewBase, BinaryViewExt},
+    binary_view::{BinaryView, BinaryViewBase, BinaryViewExt},
     debuginfo::{DebugFunctionInfo, DebugInfo},
     platform::Platform,
     rc::*,
     symbol::SymbolType,
-    templatesimplifier::simplify_str_to_fqn,
+    template_simplifier::simplify_str_to_fqn,
     types::{FunctionParameter, Type},
     variable::NamedVariableWithType,
 };

plugins/dwarf/dwarf_import/src/functions.rs

@@ -18,7 +18,7 @@ use crate::dwarfdebuginfo::{DebugInfoBuilder, DebugInfoBuilderContext, TypeUID};
 use crate::types::get_type;
 use crate::{helpers::*, ReaderType};
 
-use binaryninja::templatesimplifier::simplify_str_to_str;
+use binaryninja::template_simplifier::simplify_str_to_str;
 use cpp_demangle::DemangleOptions;
 use gimli::{constants, AttributeValue, DebuggingInformationEntry, Dwarf, Operation, Unit};
 use log::{debug, error};

plugins/dwarf/dwarf_import/src/helpers.rs

@@ -17,12 +17,12 @@ use std::path::{Path, PathBuf};
 use std::{collections::HashMap, ops::Deref, str::FromStr, sync::mpsc};
 
 use crate::{DebugInfoBuilderContext, ReaderType};
-use binaryninja::binaryview::BinaryViewBase;
-use binaryninja::filemetadata::FileMetadata;
+use binaryninja::binary_view::BinaryViewBase;
+use binaryninja::file_metadata::FileMetadata;
 use binaryninja::Endianness;
 use binaryninja::{
-    binaryview::{BinaryView, BinaryViewExt},
-    downloadprovider::{DownloadInstanceInputOutputCallbacks, DownloadProvider},
+    binary_view::{BinaryView, BinaryViewExt},
+    download_provider::{DownloadInstanceInputOutputCallbacks, DownloadProvider},
     rc::Ref,
     settings::Settings,
 };

plugins/dwarf/dwarf_import/src/lib.rs

@@ -25,12 +25,12 @@ use crate::functions::parse_function_entry;
 use crate::helpers::{get_attr_die, get_name, get_uid, DieReference};
 use crate::types::parse_variable;
 
-use binaryninja::binaryview::BinaryViewBase;
+use binaryninja::binary_view::BinaryViewBase;
 use binaryninja::{
-    binaryview::{BinaryView, BinaryViewExt},
+    binary_view::{BinaryView, BinaryViewExt},
     debuginfo::{CustomDebugInfoParser, DebugInfo, DebugInfoParser},
     settings::Settings,
-    templatesimplifier::simplify_str_to_str,
+    template_simplifier::simplify_str_to_str,
 };
 use dwarfreader::{
     create_section_reader, get_endian, is_dwo_dwarf, is_non_dwo_dwarf, is_raw_dwo_dwarf,