feat!: crate split and rename

Cargo.toml

@@ -1,7 +1,19 @@
 [workspace]
 resolver = "2"
-members = ["runtime_tracing", "runtime_tracing_cli", "trace_formatter"]
+members = [
+    "codetracer_trace_types",
+    "codetracer_trace_format_capnp",
+    "codetracer_trace_format_cbor_zstd",
+    "codetracer_trace_reader",
+    "codetracer_trace_writer",
+    "codetracer_trace_util",
+    "trace_formatter",
+]
 
 [workspace.dependencies]
-runtime_tracing = { path = "runtime_tracing/" }
 trace_formatter = { path = "trace_formatter/"}
+codetracer_trace_types = { path = "codetracer_trace_types" }
+codetracer_trace_format_capnp = { path = "codetracer_trace_format_capnp" }
+codetracer_trace_format_cbor_zstd = { path = "codetracer_trace_format_cbor_zstd" }
+codetracer_trace_reader = { path = "codetracer_trace_reader" }
+codetracer_trace_writer = { path = "codetracer_trace_writer" }

codetracer_trace_format_capnp/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "codetracer_trace_format_capnp"
+version = "0.16.0"
+edition = "2024"
+authors = ["Metacraft Labs Ltd"]
+description = "A library containing some helpers, used internally in the reading and writing of the CodeTracer db trace format"
+repository = "https://github.com/metacraft-labs/runtime_tracing"
+license = "MIT"
+keywords = ["debugging", "development-tools"]
+
+[dependencies]
+codetracer_trace_types.workspace = true
+capnp = "0.21.1"
+
+[build-dependencies]
+capnpc = "0.21.0"

codetracer_trace_format_capnp/src/lib.rs

@@ -0,0 +1,5 @@
+pub mod capnptrace;
+
+pub mod trace_capnp {
+    include!(concat!(env!("OUT_DIR"), "/src/trace_capnp.rs"));
+}

codetracer_trace_format_cbor_zstd/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "codetracer_trace_format_cbor_zstd"
+version = "0.16.0"
+edition = "2024"
+authors = ["Metacraft Labs Ltd"]
+description = "A library containing some helpers, used internally in the reading and writing of the CodeTracer db trace format"
+repository = "https://github.com/metacraft-labs/runtime_tracing"
+license = "MIT"
+keywords = ["debugging", "development-tools"]

codetracer_trace_format_cbor_zstd/src/lib.rs

@@ -0,0 +1,7 @@
+/// The next 3 bytes are reserved/version info.
+/// The header is 8 bytes in size, ensuring 64-bit alignment for the rest of the file.
+pub const HEADERV1: &[u8] = &[
+    0xC0, 0xDE, 0x72, 0xAC, 0xE2, // The first 5 bytes identify the file as a CodeTracer file (hex l33tsp33k - C0DE72ACE2 for "CodeTracer").
+    0x01, // Indicates version 1 of the file format
+    0x00, 0x00,
+]; // Reserved, must be zero in this version.

codetracer_trace_reader/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "codetracer_trace_reader"
+version = "0.16.0"
+edition = "2024"
+authors = ["Metacraft Labs Ltd"]
+description = "A library for reading the CodeTracer db trace format"
+repository = "https://github.com/metacraft-labs/runtime_tracing"
+license = "MIT"
+keywords = ["debugging", "development-tools"]
+
+[dependencies]
+codetracer_trace_types.workspace = true
+codetracer_trace_format_capnp.workspace = true
+codetracer_trace_format_cbor_zstd.workspace = true
+fscommon = "0.1.1"
+serde_json = "1.0"
+cbor4ii = { version = "1.0.0", features = ["serde1", "use_std"] }
+
+[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
+zeekstd = "0.6.0"
+
+[target.'cfg(target_arch = "wasm32")'.dependencies]
+ruzstd = "0.8.1"

runtime_tracing/src/cbor_zstd_reader.rs → codetracer_trace_reader/src/cbor_zstd_reader.rs

@@ -1,10 +1,11 @@
 use std::io::{self, BufRead, BufReader, Read, Seek, Write};
 
+use codetracer_trace_format_cbor_zstd::HEADERV1;
 use fscommon::StreamSlice;
 
 use zeekstd::Decoder;
 
-use crate::{TraceLowLevelEvent, cbor_zstd_writer::HEADERV1};
+use codetracer_trace_types::TraceLowLevelEvent;
 
 fn is_at_eof<R: BufRead>(reader: &mut R) -> io::Result<bool> {
     let buffer = reader.fill_buf()?;

runtime_tracing/src/cbor_zstd_reader_wasm.rs → codetracer_trace_reader/src/cbor_zstd_reader_wasm.rs

@@ -4,7 +4,8 @@ use fscommon::StreamSlice;
 
 use ruzstd::decoding::StreamingDecoder;
 
-use crate::{TraceLowLevelEvent, cbor_zstd_writer::HEADERV1};
+use codetracer_trace_format_cbor_zstd::HEADERV1;
+use codetracer_trace_types::TraceLowLevelEvent;
 
 fn is_at_eof<R: BufRead>(reader: &mut R) -> io::Result<bool> {
     let buffer = reader.fill_buf()?;

codetracer_trace_reader/src/lib.rs

@@ -0,0 +1,22 @@
+mod trace_readers;
+
+#[cfg(target_arch = "wasm32")]
+#[path = "./cbor_zstd_reader_wasm.rs"]
+mod cbor_zstd_reader;
+
+#[cfg(not(target_arch = "wasm32"))]
+mod cbor_zstd_reader;
+
+#[derive(Debug, Clone, Copy)]
+pub enum TraceEventsFileFormat {
+    Json,
+    BinaryV0,
+    Binary,
+}
+
+pub fn create_trace_reader(format: TraceEventsFileFormat) -> Box<dyn trace_readers::TraceReader> {
+    match format {
+        TraceEventsFileFormat::Json => Box::new(trace_readers::JsonTraceReader {}),
+        TraceEventsFileFormat::BinaryV0 | TraceEventsFileFormat::Binary => Box::new(trace_readers::BinaryTraceReader {}),
+    }
+}

runtime_tracing/src/trace_readers.rs → codetracer_trace_reader/src/trace_readers.rs

@@ -5,7 +5,10 @@ use std::{
     path::Path,
 };
 
-use crate::{TraceEventsFileFormat, TraceLowLevelEvent, capnptrace::HEADER, cbor_zstd_writer::HEADERV1};
+use crate::TraceEventsFileFormat;
+use codetracer_trace_format_cbor_zstd::HEADERV1;
+use codetracer_trace_types::TraceLowLevelEvent;
+use codetracer_trace_format_capnp::capnptrace::HEADER;
 
 pub trait TraceReader {
     fn load_trace_events(&mut self, path: &Path) -> Result<Vec<TraceLowLevelEvent>, Box<dyn Error>>;
@@ -44,7 +47,7 @@ impl TraceReader for BinaryTraceReader {
         match ver {
             Some(TraceEventsFileFormat::BinaryV0) => {
                 let mut buf_reader = BufReader::new(file);
-                Ok(crate::capnptrace::read_trace(&mut buf_reader)?)
+                Ok(codetracer_trace_format_capnp::capnptrace::read_trace(&mut buf_reader)?)
             }
             Some(TraceEventsFileFormat::Binary) => Ok(crate::cbor_zstd_reader::read_trace(&mut file)?),
             Some(TraceEventsFileFormat::Json) => {

codetracer_trace_types/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "codetracer_trace_types"
+version = "0.16.0"
+edition = "2024"
+authors = ["Metacraft Labs Ltd"]
+description = "A library for the schema for the CodeTracer db trace format"
+repository = "https://github.com/metacraft-labs/runtime_tracing"
+license = "MIT"
+keywords = ["debugging", "development-tools"]
+
+[dependencies]
+base64 = "0.22.1"
+num-traits = "0.2"
+num-derive = "0.4"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+serde_repr = "0.1"
+schemars = "0.8.2"

codetracer_trace_types/src/lib.rs

@@ -0,0 +1,13 @@
+mod base64;
+mod types;
+pub use types::*;
+
+#[test]
+fn test_equality_of_value_records() {
+    let a = ValueRecord::Int { i: 0, type_id: TypeId(0) }; // just an example type_id
+    let b = ValueRecord::Int { i: 0, type_id: TypeId(0) };
+    let different = ValueRecord::Int { i: 1, type_id: TypeId(0) };
+
+    assert_eq!(a, b);
+    assert_ne!(a, different);
+}

runtime_tracing/src/types.rs → codetracer_trace_types/src/types.rs

@@ -18,6 +18,11 @@ use schemars::JsonSchema;
 // afterwards in postprocessing
 // this assumption can change in the future
 
+pub const NONE_TYPE_ID: TypeId = TypeId(0);
+pub const NONE_VALUE: ValueRecord = ValueRecord::None { type_id: NONE_TYPE_ID };
+
+pub const TOP_LEVEL_FUNCTION_ID: FunctionId = FunctionId(0);
+
 /// Low level building blocks that make up a recorded trace.
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub enum TraceLowLevelEvent {

runtime_tracing_cli/Cargo.toml → codetracer_trace_util/Cargo.toml

@@ -1,13 +1,14 @@
 [package]
-name = "runtime_tracing_cli"
-version = "0.1.0"
-edition = "2021"
+name = "codetracer_trace_util"
+version = "0.2.0"
+edition = "2024"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 clap = { version = "4.5.40", features = ["derive"] }
-runtime_tracing.workspace = true
+codetracer_trace_reader.workspace = true
+codetracer_trace_writer.workspace = true
 trace_formatter.workspace = true
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"

runtime_tracing_cli/src/main.rs → codetracer_trace_util/src/main.rs

@@ -2,7 +2,8 @@ use std::path::Path;
 
 use crate::fmt_trace_cmd::FmtTraceCommand;
 use clap::{Args, Parser, Subcommand};
-use runtime_tracing::{create_trace_reader, create_trace_writer, TraceEventsFileFormat, TraceWriter};
+use codetracer_trace_reader::create_trace_reader;
+use codetracer_trace_writer::{create_trace_writer, trace_writer::TraceWriter};
 mod fmt_trace_cmd;
 
 #[derive(Debug, Clone, Args)]
@@ -27,11 +28,21 @@ struct RuntimeTracingCli {
     command: RuntimeTracingCliCommand,
 }
 
-fn determine_file_format_from_name(s: &str) -> Option<TraceEventsFileFormat> {
+fn determine_input_file_format_from_name(s: &str) -> Option<codetracer_trace_reader::TraceEventsFileFormat> {
     if s.ends_with(".json") {
-        Some(TraceEventsFileFormat::Json)
+        Some(codetracer_trace_reader::TraceEventsFileFormat::Json)
     } else if s.ends_with(".bin") {
-        Some(TraceEventsFileFormat::Binary)
+        Some(codetracer_trace_reader::TraceEventsFileFormat::Binary)
+    } else {
+        None
+    }
+}
+
+fn determine_output_file_format_from_name(s: &str) -> Option<codetracer_trace_writer::TraceEventsFileFormat> {
+    if s.ends_with(".json") {
+        Some(codetracer_trace_writer::TraceEventsFileFormat::Json)
+    } else if s.ends_with(".bin") {
+        Some(codetracer_trace_writer::TraceEventsFileFormat::Binary)
     } else {
         None
     }
@@ -42,8 +53,8 @@ fn main() {
 
     match args.command {
         RuntimeTracingCliCommand::Convert(convert_command) => {
-            let input_file_format = determine_file_format_from_name(&convert_command.input_file).unwrap();
-            let output_file_format = determine_file_format_from_name(&convert_command.output_file).unwrap();
+            let input_file_format = determine_input_file_format_from_name(&convert_command.input_file).unwrap();
+            let output_file_format = determine_output_file_format_from_name(&convert_command.output_file).unwrap();
             let mut trace_reader = create_trace_reader(input_file_format);
             let mut trace_writer = create_trace_writer("", &[], output_file_format);
             let mut trace_events = trace_reader.load_trace_events(Path::new(&convert_command.input_file)).unwrap();

runtime_tracing/tests/binary_format.rs → codetracer_trace_util/tests/binary_format.rs

@@ -1,11 +1,14 @@
-use runtime_tracing::{TraceEventsFileFormat, TraceWriter, create_trace_reader, create_trace_writer};
 use std::fs;
 use std::path::Path;
 
-fn test_binary_roundtrip(ver: TraceEventsFileFormat, binfile: &str) {
+use codetracer_trace_reader::create_trace_reader;
+use codetracer_trace_writer::create_trace_writer;
+use codetracer_trace_writer::trace_writer::TraceWriter;
+
+fn test_binary_roundtrip(ver: codetracer_trace_writer::TraceEventsFileFormat, binfile: &str) {
     let json_path = Path::new("tests/data/trace.json");
 
-    let mut json_reader = create_trace_reader(TraceEventsFileFormat::Json);
+    let mut json_reader = create_trace_reader(codetracer_trace_reader::TraceEventsFileFormat::Json);
     let original = json_reader.load_trace_events(json_path).unwrap();
 
     let bin_path_str = format!("tests/data/{}", binfile);
@@ -16,7 +19,7 @@ fn test_binary_roundtrip(ver: TraceEventsFileFormat, binfile: &str) {
     TraceWriter::append_events(bin_writer.as_mut(), &mut original.clone());
     bin_writer.finish_writing_trace_events().unwrap();
 
-    let mut bin_reader = create_trace_reader(TraceEventsFileFormat::Binary);
+    let mut bin_reader = create_trace_reader(codetracer_trace_reader::TraceEventsFileFormat::Binary);
     let tracer2_events = bin_reader.load_trace_events(bin_path).unwrap();
 
     fs::remove_file(bin_path).unwrap();
@@ -29,10 +32,10 @@ fn test_binary_roundtrip(ver: TraceEventsFileFormat, binfile: &str) {
 
 #[test]
 fn test_binary_roundtrip_v0() {
-    test_binary_roundtrip(TraceEventsFileFormat::BinaryV0, "trace.v0.bin");
+    test_binary_roundtrip(codetracer_trace_writer::TraceEventsFileFormat::BinaryV0, "trace.v0.bin");
 }
 
 #[test]
 fn test_binary_roundtrip_v1() {
-    test_binary_roundtrip(TraceEventsFileFormat::Binary, "trace.v1.bin");
+    test_binary_roundtrip(codetracer_trace_writer::TraceEventsFileFormat::Binary, "trace.v1.bin");
 }

codetracer_trace_writer/Cargo.toml

@@ -0,0 +1,22 @@
+[package]
+name = "codetracer_trace_writer"
+version = "0.16.0"
+edition = "2024"
+authors = ["Metacraft Labs Ltd"]
+description = "A library for writing the CodeTracer db trace format"
+repository = "https://github.com/metacraft-labs/runtime_tracing"
+license = "MIT"
+keywords = ["debugging", "development-tools"]
+
+[dependencies]
+codetracer_trace_types.workspace = true
+codetracer_trace_format_capnp.workspace = true
+codetracer_trace_format_cbor_zstd.workspace = true
+serde_json = "1.0"
+cbor4ii = { version = "1.0.0", features = ["serde1", "use_std"] }
+
+[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
+zeekstd = "0.6.0"
+
+[target.'cfg(target_arch = "wasm32")'.dependencies]
+ruzstd = "0.8.1"