Reduce usage of IntoCStr in Rust API signatures

This is being done to reduce complexity in function signatures, specifically many of the strings we are passing ultimately should be new types themselves instead of "just strings", things such as type ids.

Another place which was confusing was dealing with filesystem related APIs, this commit turns most of those params into a stricter `Path` type.

This is bringing the rust api more inline with both python and C++, where the wrapper eagerly converts the string into the languages standard string type.

Special consideration must be made for symbols or other possible non utf-8 objects.

This commit will be followed up with one that adds the `IntoCStr` bound on API's we want to keep as invalid utf-8 so we can for example, get section by name on a section with invalid utf-8.

Author: emesare

plugins/dwarf/dwarf_import/src/die_handlers.rs

@@ -47,19 +47,19 @@ pub(crate) fn handle_base_type<R: ReaderType>(
                 constants::DW_ATE_address => None,
                 constants::DW_ATE_boolean => Some(Type::bool()),
                 constants::DW_ATE_complex_float => None,
-                constants::DW_ATE_float => Some(Type::named_float(size, name)),
-                constants::DW_ATE_signed => Some(Type::named_int(size, true, name)),
-                constants::DW_ATE_signed_char => Some(Type::named_int(size, true, name)),
-                constants::DW_ATE_unsigned => Some(Type::named_int(size, false, name)),
-                constants::DW_ATE_unsigned_char => Some(Type::named_int(size, false, name)),
+                constants::DW_ATE_float => Some(Type::named_float(size, &name)),
+                constants::DW_ATE_signed => Some(Type::named_int(size, true, &name)),
+                constants::DW_ATE_signed_char => Some(Type::named_int(size, true, &name)),
+                constants::DW_ATE_unsigned => Some(Type::named_int(size, false, &name)),
+                constants::DW_ATE_unsigned_char => Some(Type::named_int(size, false, &name)),
                 constants::DW_ATE_imaginary_float => None,
                 constants::DW_ATE_packed_decimal => None,
                 constants::DW_ATE_numeric_string => None,
                 constants::DW_ATE_edited => None,
                 constants::DW_ATE_signed_fixed => None,
                 constants::DW_ATE_unsigned_fixed => None,
-                constants::DW_ATE_decimal_float => Some(Type::named_float(size, name)),
-                constants::DW_ATE_UTF => Some(Type::named_int(size, false, name)), // TODO : Verify
+                constants::DW_ATE_decimal_float => Some(Type::named_float(size, &name)),
+                constants::DW_ATE_UTF => Some(Type::named_int(size, false, &name)), // TODO : Verify
                 constants::DW_ATE_UCS => None,
                 constants::DW_ATE_ASCII => None, // Some sort of array?
                 constants::DW_ATE_lo_user => None,
@@ -114,7 +114,7 @@ pub(crate) fn handle_enum<R: ReaderType>(
             match &child.entry().attr(constants::DW_AT_const_value) {
                 Ok(Some(attr)) => {
                     if let Some(value) = get_attr_as_u64(attr) {
-                        enumeration_builder.insert(name, value);
+                        enumeration_builder.insert(&name, value);
                     } else {
                         // Somehow the child entry is not a const value.
                         log::error!("Unhandled enum member value type for `{}`", name);

plugins/dwarf/dwarf_import/src/dwarfdebuginfo.rs

@@ -546,7 +546,7 @@ impl DebugInfoBuilder {
             assert!(debug_info.add_data_variable(
                 address,
                 &self.get_type(*type_uid).unwrap().ty,
-                name.clone(),
+                name.as_deref(),
                 &[] // TODO : Components
             ));
         }

plugins/dwarf/dwarf_import/src/helpers.rs

@@ -14,7 +14,7 @@
 
 use std::ffi::OsStr;
 use std::path::{Path, PathBuf};
-use std::{collections::HashMap, ops::Deref, str::FromStr, sync::mpsc};
+use std::{ops::Deref, str::FromStr, sync::mpsc};
 
 use crate::{DebugInfoBuilderContext, ReaderType};
 use binaryninja::binary_view::BinaryViewBase;
@@ -450,8 +450,8 @@ pub(crate) fn download_debug_info(
         let result = inst
             .perform_custom_request(
                 "GET",
-                artifact_url,
-                HashMap::<String, String>::new(),
+                &artifact_url,
+                vec![],
                 DownloadInstanceInputOutputCallbacks {
                     read: None,
                     write: Some(Box::new(write)),

plugins/dwarf/dwarf_import/src/types.rs

@@ -215,17 +215,17 @@ fn do_structure_parse<R: ReaderType>(
                     });
 
                     structure_builder.insert(
-                        child_type.as_ref(),
-                        child_name,
+                        &child_type,
+                        &child_name,
                         struct_offset,
                         false,
                         MemberAccess::NoAccess, // TODO : Resolve actual scopes, if possible
                         MemberScope::NoScope,
                     );
                 } else {
                     structure_builder.append(
-                        child_type.as_ref(),
-                        child_name,
+                        &child_type,
+                        &child_name,
                         MemberAccess::NoAccess,
                         MemberScope::NoScope,
                     );

plugins/dwarf/shared/src/lib.rs

@@ -179,9 +179,10 @@ pub fn create_section_reader<'a, Endian: 'a + Endianity>(
         }
     }
     // Truncate Mach-O section names to 16 bytes
-    else if let Some(section) =
-        view.section_by_name("__".to_string() + &section_name[1..section_name.len().min(15)])
-    {
+    else if let Some(section) = view.section_by_name(&format!(
+        "__{}",
+        &section_name[1..section_name.len().min(15)]
+    )) {
         Ok(EndianRcSlice::new(
             Rc::from(view.read_vec(section.start(), section.len()).as_slice()),
             endian,

plugins/idb_import/src/lib.rs

@@ -198,7 +198,7 @@ pub fn import_til_section(
         if let TranslateTypeResult::Translated(bn_ty)
         | TranslateTypeResult::PartiallyTranslated(bn_ty, _) = &ty.ty
         {
-            if !debug_info.add_type(ty.name.as_utf8_lossy(), bn_ty, &[/* TODO */]) {
+            if !debug_info.add_type(&ty.name.as_utf8_lossy(), bn_ty, &[/* TODO */]) {
                 error!("Unable to add type `{}`", ty.name.as_utf8_lossy())
             }
         }
@@ -209,7 +209,7 @@ pub fn import_til_section(
         if let TranslateTypeResult::Translated(bn_ty)
         | TranslateTypeResult::PartiallyTranslated(bn_ty, _) = &ty.ty
         {
-            if !debug_info.add_type(ty.name.as_utf8_lossy(), bn_ty, &[/* TODO */]) {
+            if !debug_info.add_type(&ty.name.as_utf8_lossy(), bn_ty, &[/* TODO */]) {
                 error!("Unable to fix type `{}`", ty.name.as_utf8_lossy())
             }
         }
@@ -239,10 +239,7 @@ fn parse_id0_section_info(
         } = info;
         // TODO set comments to address here
         for function in &bv.functions_containing(addr) {
-            function.set_comment_at(
-                addr,
-                String::from_utf8_lossy(&comments.join(&b"\n"[..])).to_string(),
-            );
+            function.set_comment_at(addr, &String::from_utf8_lossy(&comments.join(&b"\n"[..])));
         }
 
         let bnty = ty

plugins/idb_import/src/types.rs

@@ -335,7 +335,7 @@ impl<F: Fn(usize, usize) -> Result<(), ()>> TranslateIDBTypes<'_, F> {
                 format!("bitfield_{}_{}", offset + start_idx, offset + (i - 1))
             };
             let field = field_from_bytes(bytes);
-            struct_builder.append(&field, name, MemberAccess::NoAccess, MemberScope::NoScope);
+            struct_builder.append(&field, &name, MemberAccess::NoAccess, MemberScope::NoScope);
         };
 
         for (i, member) in members {
@@ -423,7 +423,7 @@ impl<F: Fn(usize, usize) -> Result<(), ()>> TranslateIDBTypes<'_, F> {
                 .as_ref()
                 .map(|name| name.as_utf8_lossy().to_string())
                 .unwrap_or_else(|| format!("member_{i}"));
-            structure.append(&mem, name, MemberAccess::NoAccess, MemberScope::NoScope);
+            structure.append(&mem, &name, MemberAccess::NoAccess, MemberScope::NoScope);
         }
         if let Some(start_idx) = first_bitfield_seq {
             let members_bitrange = &ty_struct.members[start_idx..];
@@ -470,7 +470,7 @@ impl<F: Fn(usize, usize) -> Result<(), ()>> TranslateIDBTypes<'_, F> {
                 .as_ref()
                 .map(|name| name.as_utf8_lossy().to_string())
                 .unwrap_or_else(|| format!("member_{i}"));
-            structure.append(&mem, name, MemberAccess::NoAccess, MemberScope::NoScope);
+            structure.append(&mem, &name, MemberAccess::NoAccess, MemberScope::NoScope);
         }
         let str_ref = structure.finalize();
 
@@ -492,7 +492,7 @@ impl<F: Fn(usize, usize) -> Result<(), ()>> TranslateIDBTypes<'_, F> {
                 .as_ref()
                 .map(|name| name.as_utf8_lossy().to_string())
                 .unwrap_or_else(|| format!("member_{i}"));
-            eb.insert(name, member.value);
+            eb.insert(&name, member.value);
         }
         Type::enumeration(
             &eb.finalize(),

plugins/pdb-ng/src/lib.rs

@@ -13,7 +13,6 @@
 // limitations under the License.
 #![allow(dead_code)]
 
-use std::collections::HashMap;
 use std::env::{current_dir, current_exe, temp_dir};
 use std::io::Cursor;
 use std::path::PathBuf;
@@ -31,7 +30,6 @@ use binaryninja::download_provider::{DownloadInstanceInputOutputCallbacks, Downl
 use binaryninja::interaction::{MessageBoxButtonResult, MessageBoxButtonSet};
 use binaryninja::logger::Logger;
 use binaryninja::settings::{QueryOptions, Settings};
-use binaryninja::string::BnString;
 use binaryninja::{interaction, user_directory};
 use parser::PDBParserInstance;
 
@@ -196,7 +194,7 @@ fn read_from_sym_store(bv: &BinaryView, path: &str) -> Result<(bool, Vec<u8>)> {
         .perform_custom_request(
             "GET",
             path,
-            HashMap::<BnString, BnString>::new(),
+            vec![],
             DownloadInstanceInputOutputCallbacks {
                 read: None,
                 write: Some(Box::new(write)),
@@ -278,21 +276,21 @@ fn search_sym_store(
 }
 
 fn parse_pdb_info(view: &BinaryView) -> Option<PDBInfo> {
-    match view.get_metadata::<u64, _>("DEBUG_INFO_TYPE") {
+    match view.get_metadata::<u64>("DEBUG_INFO_TYPE") {
         Some(Ok(0x53445352 /* 'SDSR' */)) => {}
         _ => return None,
     }
 
     // This is stored in the BV by the PE loader
-    let file_path = match view.get_metadata::<String, _>("PDB_FILENAME") {
+    let file_path = match view.get_metadata::<String>("PDB_FILENAME") {
         Some(Ok(md)) => md,
         _ => return None,
     };
-    let mut guid = match view.get_metadata::<Vec<u8>, _>("PDB_GUID") {
+    let mut guid = match view.get_metadata::<Vec<u8>>("PDB_GUID") {
         Some(Ok(md)) => md,
         _ => return None,
     };
-    let age = match view.get_metadata::<u64, _>("PDB_AGE") {
+    let age = match view.get_metadata::<u64>("PDB_AGE") {
         Some(Ok(md)) => md as u32,
         _ => return None,
     };

plugins/pdb-ng/src/parser.rs

@@ -168,7 +168,8 @@ impl<'a, S: Source<'a> + 'a> PDBParserInstance<'a, S> {
     ) -> Result<()> {
         self.parse_types(Self::split_progress(&progress, 0, &[1.0, 3.0, 0.5, 0.5]))?;
         for (name, ty) in self.named_types.iter() {
-            self.debug_info.add_type(name, ty.as_ref(), &[]); // TODO : Components
+            self.debug_info
+                .add_type(&name.to_string(), ty.as_ref(), &[]); // TODO : Components
         }
 
         info!(
@@ -406,7 +407,8 @@ impl<'a, S: Source<'a> + 'a> PDBParserInstance<'a, S> {
             match class {
                 NamedTypeReferenceClass::UnknownNamedTypeClass
                 | NamedTypeReferenceClass::TypedefNamedTypeClass => {
-                    self.debug_info.add_type(&name, Type::void().as_ref(), &[]);
+                    self.debug_info
+                        .add_type(&name.to_string(), Type::void().as_ref(), &[]);
                     // TODO : Components
                 }
                 NamedTypeReferenceClass::ClassNamedTypeClass
@@ -429,15 +431,15 @@ impl<'a, S: Source<'a> + 'a> PDBParserInstance<'a, S> {
                     structure.alignment(1);
 
                     self.debug_info.add_type(
-                        &name,
+                        &name.to_string(),
                         Type::structure(structure.finalize().as_ref()).as_ref(),
                         &[], // TODO : Components
                     );
                 }
                 NamedTypeReferenceClass::EnumNamedTypeClass => {
                     let enumeration = EnumerationBuilder::new();
                     self.debug_info.add_type(
-                        &name,
+                        &name.to_string(),
                         Type::enumeration(
                             enumeration.finalize().as_ref(),
                             self.arch.default_integer_size().try_into()?,

plugins/pdb-ng/src/struct_grouper.rs

@@ -361,7 +361,7 @@ pub fn group_structure(
             for member in members {
                 structure.insert(
                     &member.ty,
-                    member.name.clone(),
+                    &member.name,
                     member.offset,
                     false,
                     member.access,
@@ -390,7 +390,7 @@ fn apply_groups(
                 if offset > member.offset {
                     structure.insert(
                         &member.ty,
-                        member.name.clone(),
+                        &member.name,
                         0,
                         false,
                         member.access,
@@ -399,7 +399,7 @@ fn apply_groups(
                 } else {
                     structure.insert(
                         &member.ty,
-                        member.name.clone(),
+                        &member.name,
                         member.offset - offset,
                         false,
                         member.access,
@@ -412,7 +412,7 @@ fn apply_groups(
                 apply_groups(members, &mut inner, children, inner_offset);
                 structure.insert(
                     &Conf::new(Type::structure(inner.finalize().as_ref()), MAX_CONFIDENCE),
-                    format!("__inner{}", i),
+                    &format!("__inner{}", i),
                     inner_offset - offset,
                     false,
                     MemberAccess::PublicAccess,
@@ -425,7 +425,7 @@ fn apply_groups(
                 apply_groups(members, &mut inner, children, inner_offset);
                 structure.insert(
                     &Conf::new(Type::structure(inner.finalize().as_ref()), MAX_CONFIDENCE),
-                    format!("__inner{}", i),
+                    &format!("__inner{}", i),
                     inner_offset - offset,
                     false,
                     MemberAccess::PublicAccess,