Split out samply-object crate (#689)

Author: mstange

Cargo.lock

@@ -6,6 +6,7 @@ members = [
     "gecko_profile",
     "samply-api",
     "samply-debugid",
+    "samply-object",
     "samply-quota-manager",
     "samply-symbols",
     "samply",

Cargo.toml

@@ -14,6 +14,7 @@ default = []
 send_futures = ["samply-symbols/send_futures"]
 
 [dependencies]
+samply-debugid = { version = "0.1.0", path = "../samply-debugid" }
 samply-symbols = { version = "0.24.1", path = "../samply-symbols" }
 thiserror = "2"
 serde = "1.0.204"

samply-api/Cargo.toml

@@ -1,8 +1,9 @@
 use std::str::FromStr;
 
+use samply_debugid::CodeId;
 use samply_symbols::debugid::DebugId;
 use samply_symbols::{
-    object, CodeByteReadingError, CodeId, FileAndPathHelper, FileAndPathHelperError, LibraryInfo,
+    object, CodeByteReadingError, FileAndPathHelper, FileAndPathHelperError, LibraryInfo,
     LookupAddress, SymbolManager,
 };
 use yaxpeax_arch::{Arch, DecodeError, LengthedInstruction, Reader, U8Reader};

samply-api/src/asm/mod.rs

@@ -12,11 +12,6 @@ readme = "README.md"
 default-features = false
 version = "0.8.0"
 
-[dependencies.object]
-default-features = false
-features = ["read_core"]
-version = "0.37"
-
 [dependencies.uuid]
 default-features = false
 version = "1"

samply-debugid/Cargo.toml

@@ -1,6 +1,5 @@
 use std::str::FromStr;
 
-use object::Object;
 use uuid::Uuid;
 
 /// An enum carrying an identifier for a binary. This is stores the same information
@@ -147,20 +146,3 @@ impl std::fmt::Display for ElfBuildId {
         Ok(())
     }
 }
-
-/// Tries to obtain a CodeId for an object.
-///
-/// This currently only handles mach-O and ELF.
-pub fn code_id_for_object<'data>(obj: &impl Object<'data>) -> Option<CodeId> {
-    // ELF
-    if let Ok(Some(build_id)) = obj.build_id() {
-        return Some(CodeId::ElfBuildId(ElfBuildId::from_bytes(build_id)));
-    }
-
-    // mach-O
-    if let Ok(Some(uuid)) = obj.mach_uuid() {
-        return Some(CodeId::MachoUuid(Uuid::from_bytes(uuid)));
-    }
-
-    None
-}

samply-debugid/src/codeid.rs

@@ -1,5 +1,4 @@
 use debugid::DebugId;
-use object::{Object, ObjectSection};
 use uuid::Uuid;
 
 pub trait DebugIdExt {
@@ -60,37 +59,3 @@ impl DebugIdExt for DebugId {
         DebugId::from_identifier(&hash, little_endian)
     }
 }
-
-/// Tries to obtain a DebugId for an object. This uses the build ID, if available,
-/// and falls back to hashing the first page of the text section otherwise.
-/// Returns None on failure.
-pub fn debug_id_for_object<'data>(obj: &impl Object<'data>) -> Option<DebugId> {
-    // Windows
-    if let Ok(Some(pdb_info)) = obj.pdb_info() {
-        return Some(DebugId::from_guid_age(&pdb_info.guid(), pdb_info.age()).unwrap());
-    }
-
-    // ELF
-    if let Ok(Some(build_id)) = obj.build_id() {
-        return Some(DebugId::from_identifier(build_id, obj.is_little_endian()));
-    }
-
-    // mach-O
-    if let Ok(Some(uuid)) = obj.mach_uuid() {
-        return Some(DebugId::from_uuid(Uuid::from_bytes(uuid)));
-    }
-
-    // We were not able to locate a build ID, so fall back to creating a synthetic
-    // identifier from a hash of the first page of the ".text" (program code) section.
-    if let Some(section) = obj.section_by_name(".text") {
-        let data_len = section.size().min(4096);
-        if let Ok(Some(first_page_data)) = section.data_range(section.address(), data_len) {
-            return Some(DebugId::from_text_first_page(
-                first_page_data,
-                obj.is_little_endian(),
-            ));
-        }
-    }
-
-    None
-}

samply-debugid/src/debugid.rs

@@ -1,5 +1,5 @@
 mod codeid;
 mod debugid;
 
-pub use codeid::{code_id_for_object, CodeId, ElfBuildId, PeCodeId};
-pub use debugid::{debug_id_for_object, DebugIdExt};
+pub use codeid::{CodeId, ElfBuildId, PeCodeId};
+pub use debugid::DebugIdExt;

samply-debugid/src/lib.rs

@@ -0,0 +1,25 @@
+[package]
+name = "samply-object"
+version = "0.1.0"
+authors = ["Markus Stange <[email protected]>"]
+license = "MIT OR Apache-2.0"
+edition = "2021"
+description = "Samply object functions."
+repository = "https://github.com/mstange/samply/"
+readme = "README.md"
+
+[dependencies.debugid]
+default-features = false
+version = "0.8.0"
+
+[dependencies.object]
+default-features = false
+features = ["read_core"]
+version = "0.37"
+
+[dependencies.uuid]
+default-features = false
+version = "1"
+
+[dependencies]
+samply-debugid = { version = "0.1.0", path = "../samply-debugid" }

samply-object/Cargo.toml

@@ -0,0 +1,5 @@
+# samply-object
+
+This crate defines the functions for getting `DebugId`s, `CodeId`s and relative
+base addresses for use with `samply`. Useful for writing your own profiles to
+be symbolicated and displayed with `samply load`.